StructureDefinition
activeFoundationA 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.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| StructureDefinition | 0..* | — | Structural Definition |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) |
| .identifierΣ | 0..* | Identifier | Additional identifier for the structure definition |
| .versionΣ | 0..1 | string | Business version of the structure definition |
| .nameΣ | 1..1 | string | Name for this structure definition (computer friendly) |
| .titleΣ | 0..1 | string | Name for this structure definition (human friendly) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .dateΣ | 0..1 | dateTime | Date last changed |
| .publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
| .contactΣ | 0..* | ContactDetail | Contact details for the publisher |
| .description | 0..1 | markdown | Natural language description of the structure definition |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for structure definition (if applicable) Bindingjurisdiction(extensible) |
| .purpose | 0..1 | markdown | Why this structure definition is defined |
| .copyright | 0..1 | markdown | Use and/or publishing restrictions |
| .keywordΣ | 0..* | Coding | Assist with indexing and finding Bindingdefinition-use(extensible) |
| .fhirVersionΣ | 0..1 | code | FHIR Version this StructureDefinition targets BindingFHIR-version(required) |
| .mapping | 0..* | BackboneElement | External specification that the content is mapped to |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .identity | 1..1 | id | Internal id when this mapping is used |
| .uri | 0..1 | uri | Identifies what this mapping refers to |
| .name | 0..1 | string | Names what this mapping refers to |
| .comment | 0..1 | string | Versions, Issues, Scope limitations etc. |
| .kindΣ | 1..1 | code | primitive-type | complex-type | resource | logical Bindingstructure-definition-kind(required) |
| .abstractΣ | 1..1 | boolean | Whether the structure is abstract |
| .contextΣ | 0..* | BackboneElement | If an extension, where it can be used in instances |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .typeΣ | 1..1 | code | fhirpath | element | extension Bindingextension-context-type(required) |
| .expressionΣ | 1..1 | string | Where the extension can be used in instances |
| .contextInvariantΣ | 0..* | string | FHIRPath invariants - when the extension can be used |
| .typeΣ | 1..1 | uri | Type defined or constrained by this structure Bindingdefined-types(extensible) |
| .baseDefinitionΣ | 0..1 | canonical | Definition that this type is constrained/specialized from |
| .derivationΣ | 0..1 | code | specialization | constraint - How relates to base definition Bindingtype-derivation-rule(required) |
| .snapshot | 0..1 | BackboneElement | Snapshot view of the structure |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .element | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) |
| .differential | 0..1 | BackboneElement | Differential view of the structure |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .element | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) |