Skip to main content

StructureDefinition

A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url1..1uriCanonical identifier for this structure definition, represented as a URI (globally unique)
identifier0..*IdentifierAdditional identifier for the structure definition
version0..1stringBusiness version of the structure definition
name1..1stringName for this structure definition (computer friendly)
title0..1stringName for this structure definition (human friendly)
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the structure definition
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for structure definition (if applicable)
purpose0..1markdownWhy this structure definition is defined
copyright0..1markdownUse and/or publishing restrictions
keyword0..*CodingAssist with indexing and finding
fhirVersion0..1codeFHIR Version this StructureDefinition targets
mapping0..*BackboneElementExternal specification that the content is mapped to
kind1..1codeprimitive-type | complex-type | resource | logical
abstract1..1booleanWhether the structure is abstract
context0..*BackboneElementIf an extension, where it can be used in instances
contextInvariant0..*stringFHIRPath invariants - when the extension can be used
type1..1uriType defined or constrained by this structure
baseDefinition0..1canonicalDefinition that this type is constrained/specialized from
derivation0..1codespecialization | constraint - How relates to base definition
snapshot0..1BackboneElementSnapshot view of the structure
differential0..1BackboneElementDifferential view of the structure

Search Parameters

NameTypeDescriptionExpression
contexttokenA use context assigned to the structure definitionStructureDefinition.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the structure definitionStructureDefinition.useContext.value
context-typetokenA type of use context assigned to the structure definitionStructureDefinition.useContext.code
datedateThe structure definition publication dateStructureDefinition.date
descriptionstringThe description of the structure definitionStructureDefinition.description
jurisdictiontokenIntended jurisdiction for the structure definitionStructureDefinition.jurisdiction
namestringComputationally friendly name of the structure definitionStructureDefinition.name
publisherstringName of the publisher of the structure definitionStructureDefinition.publisher
statustokenThe current status of the structure definitionStructureDefinition.status
titlestringThe human-friendly name of the structure definitionStructureDefinition.title
urluriThe uri that identifies the structure definitionStructureDefinition.url
versiontokenThe business version of the structure definitionStructureDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the structure definitionStructureDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the structure definitionStructureDefinition.useContext
identifiertokenExternal identifier for the structure definitionStructureDefinition.identifier
abstracttokenWhether the structure is abstractStructureDefinition.abstract
basereferenceDefinition that this type is constrained/specialized fromStructureDefinition.baseDefinition
base-pathtokenPath that identifies the base elementStructureDefinition.snapshot.element.base.path
derivationtokenspecialization | constraint - How relates to base definitionStructureDefinition.derivation
experimentaltokenFor testing purposes, not real usageStructureDefinition.experimental
ext-contexttokenThe system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element\|CodeableConcept.textStructureDefinition.context.type
keywordtokenA code for the StructureDefinitionStructureDefinition.keyword
kindtokenprimitive-type | complex-type | resource | logicalStructureDefinition.kind
pathtokenA path that is constrained in the StructureDefinitionStructureDefinition.snapshot.element.path
typeuriType defined or constrained by this structureStructureDefinition.type
valuesetreferenceA vocabulary binding referenceStructureDefinition.snapshot.element.binding.valueSet