SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base/ and changes regularly. See the Directory of published versions
Resource Profile: SMART Guidelines Logical Model
| Official URL: http://smart.who.int/base/StructureDefinition/SGLogicalModel | Version: 0.3.0 | |||
| Draft as of 2026-10-20 | Computable Name: SGLogicalModel | |||
Defines the minimum expectations for Logical Models used in SMART Guidelines
Usages:
- Refer to this Profile: SMART Guidelines ImplementationGuide
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  StructureDefinition |
C | 0..* | StructureDefinition | Structural Definition Constraints: sdf-0, sdf-1, sdf-15a, sdf-4, sdf-5, sdf-6, sdf-9, sdf-11, sdf-14, sdf-15, sdf-16, sdf-17, sdf-18, sdf-19, sdf-21, sdf-22, sdf-23 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| url |
1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) | |
| name |
C | 1..1 | string | Name for this structure definition (computer friendly) |
| title |
1..1 | string | Name for this structure definition (human friendly) | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| description |
1..1 | markdown | Natural language description of the structure definition | |
| kind |
1..1 | code | primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical (extensions allowed) | |
| abstract |
1..1 | boolean | Whether the structure is abstract | |
| type |
C | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. |
  differential |
C | 0..1 | BackboneElement | Differential view of the structure Constraints: sdf-20, sdf-8a |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| element |
1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| path |
1..1 | string | Path of the element in the hierarchy of elements | |
  Slices for code |
1..* | Coding | Corresponding codes in terminologies Slice: Unordered, Open by pattern:system Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   code:smart |
1..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
  system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart (extensions allowed) | |
| code:loinc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/loinc (extensions allowed) | |
| code:snomed |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/snomed (extensions allowed) | |
| code:icd-10 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-10 (extensions allowed) | |
| code:icd-11 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-11 (extensions allowed) | |
| code:icf |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icf (extensions allowed) | |
| code:ichi |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/ichi (extensions allowed) | |
| code:snomed-gps |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart-gps (extensions allowed) | |
 code:atc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/atc (extensions allowed) | |
| short |
1..1 | string | Concise definition for space-constrained presentation | |
| definition |
1..1 | markdown | Full formal definition as narrative text | |
| max |
C | 0..1 | string | Maximum Cardinality (a number or *) Constraints: eld-3 |
| type |
C | 1..1 | Element | Data type and Profile for this element Constraints: eld-4, eld-17 |
 code |
1..1 | uri | Data type or Resource (reference to definition) Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | |
 fixed[x] |
C | 0..1 | Value must be exactly this | |
| fixedBase64Binary |
base64Binary | |||
| fixedBoolean |
boolean | |||
 fixedCanonical |
canonical(Any) | |||
| fixedCode |
code | |||
| fixedDate |
date | |||
| fixedDateTime |
dateTime | |||
| fixedDecimal |
decimal | |||
| fixedId |
id | |||
| fixedInstant |
instant | |||
| fixedInteger |
integer | |||
| fixedMarkdown |
markdown | |||
| fixedOid |
oid | |||
| fixedPositiveInt |
positiveInt | |||
| fixedString |
string | |||
| fixedTime |
time | |||
| fixedUnsignedInt |
unsignedInt | |||
| fixedUri |
uri | |||
| fixedUrl |
url | |||
| fixedUuid |
uuid | |||
| fixedAddress |
Address | |||
| fixedAge |
Age | |||
| fixedAnnotation |
Annotation | |||
| fixedAttachment |
Attachment | |||
| fixedCodeableConcept |
CodeableConcept | |||
| fixedCoding |
Coding | |||
| fixedContactPoint |
ContactPoint | |||
| fixedCount |
Count | |||
| fixedDistance |
Distance | |||
| fixedDuration |
Duration | |||
| fixedHumanName |
HumanName | |||
| fixedIdentifier |
Identifier | |||
| fixedMoney |
Money | |||
| fixedPeriod |
Period | |||
| fixedQuantity |
Quantity | |||
| fixedRange |
Range | |||
| fixedRatio |
Ratio | |||
| fixedReference |
Reference(Any) | |||
| fixedSampledData |
SampledData | |||
| fixedSignature |
Signature | |||
| fixedTiming |
Timing | |||
| fixedContactDetail |
ContactDetail | |||
| fixedContributor |
Contributor | |||
| fixedDataRequirement |
DataRequirement | |||
| fixedExpression |
Expression | |||
| fixedParameterDefinition |
ParameterDefinition | |||
| fixedRelatedArtifact |
RelatedArtifact | |||
| fixedTriggerDefinition |
TriggerDefinition | |||
| fixedUsageContext |
UsageContext | |||
| fixedDosage |
Dosage | |||
| fixedMeta |
Meta | |||
| pattern[x] |
C | 0..1 | Value must have at least these property values | |
| patternBase64Binary |
base64Binary | |||
| patternBoolean |
boolean | |||
| patternCanonical |
canonical(Any) | |||
| patternCode |
code | |||
| patternDate |
date | |||
| patternDateTime |
dateTime | |||
| patternDecimal |
decimal | |||
| patternId |
id | |||
| patternInstant |
instant | |||
| patternInteger |
integer | |||
| patternMarkdown |
markdown | |||
| patternOid |
oid | |||
| patternPositiveInt |
positiveInt | |||
| patternString |
string | |||
| patternTime |
time | |||
| patternUnsignedInt |
unsignedInt | |||
| patternUri |
uri | |||
| patternUrl |
url | |||
| patternUuid |
uuid | |||
| patternAddress |
Address | |||
| patternAge |
Age | |||
| patternAnnotation |
Annotation | |||
| patternAttachment |
Attachment | |||
| patternCodeableConcept |
CodeableConcept | |||
| patternCoding |
Coding | |||
| patternContactPoint |
ContactPoint | |||
| patternCount |
Count | |||
| patternDistance |
Distance | |||
| patternDuration |
Duration | |||
| patternHumanName |
HumanName | |||
| patternIdentifier |
Identifier | |||
| patternMoney |
Money | |||
| patternPeriod |
Period | |||
| patternQuantity |
Quantity | |||
| patternRange |
Range | |||
| patternRatio |
Ratio | |||
| patternReference |
Reference(Any) | |||
| patternSampledData |
SampledData | |||
| patternSignature |
Signature | |||
| patternTiming |
Timing | |||
| patternContactDetail |
ContactDetail | |||
| patternContributor |
Contributor | |||
| patternDataRequirement |
DataRequirement | |||
| patternExpression |
Expression | |||
| patternParameterDefinition |
ParameterDefinition | |||
| patternRelatedArtifact |
RelatedArtifact | |||
| patternTriggerDefinition |
TriggerDefinition | |||
| patternUsageContext |
UsageContext | |||
| patternDosage |
Dosage | |||
| patternMeta |
Meta | |||
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| StructureDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| StructureDefinition.kind | Base | required | StructureDefinitionKind | 📍4.0.1 | FHIR Std. |
| StructureDefinition.type | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:smart | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:loinc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-10 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-11 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icf | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:ichi | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed-gps | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:atc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.code | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | StructureDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | StructureDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | StructureDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| eld-3 | error | StructureDefinition.differential.element.max | Max SHALL be a number or "*" |
empty() or ($this = '*') or (toInteger() >= 0)
|
| eld-4 | error | StructureDefinition.differential.element.type | Aggregation may only be specified if one of the allowed types for the element is a reference |
aggregation.empty() or (code = 'Reference') or (code = 'canonical')
|
| eld-17 | error | StructureDefinition.differential.element.type | targetProfile is only allowed if the type is Reference or canonical |
(code='Reference' or code = 'canonical') or targetProfile.empty()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sdf-0 | warning | StructureDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| sdf-1 | error | StructureDefinition | Element paths must be unique unless the structure is a constraint |
derivation = 'constraint' or snapshot.element.select(path).isDistinct()
|
| sdf-4 | error | StructureDefinition |
If the structure is not abstract, then there SHALL be a baseDefinition Requirements: Ensure that the base types are abstract |
abstract = true or baseDefinition.exists()
|
| sdf-5 | error | StructureDefinition | If the structure defines an extension then the structure must have context information |
type != 'Extension' or derivation = 'specialization' or (context.exists())
|
| sdf-6 | error | StructureDefinition | A structure must have either a differential, or a snapshot (or both) |
snapshot.exists() or differential.exists()
|
| sdf-9 | error | StructureDefinition |
In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element) Requirements: Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition |
children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()
|
| sdf-11 | error | StructureDefinition |
If there's a type, its content must match the path name in the first element of a snapshot Requirements: Ensure that the type is not inconsistent with the other information in the structure |
kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type
|
| sdf-14 | error | StructureDefinition |
All element definitions must have an id Requirements: elements have id |
snapshot.element.all(id.exists()) and differential.element.all(id.exists())
|
| sdf-15 | error | StructureDefinition |
The first element in a snapshot has no type unless model is a logical model. Requirements: No Type on the root element (snapshot) |
kind!='logical' implies snapshot.element.first().type.empty()
|
| sdf-15a | error | StructureDefinition |
If the first element in a differential has no "." in the path and it's not a logical model, it has no type Requirements: No Type on the root element (differential) |
(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()
|
| sdf-16 | error | StructureDefinition |
All element definitions must have unique ids (snapshot) Requirements: element ids need to be unique |
snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()
|
| sdf-17 | error | StructureDefinition |
All element definitions must have unique ids (diff) Requirements: element ids need to be unique |
differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()
|
| sdf-18 | error | StructureDefinition |
Context Invariants can only be used for extensions Requirements: contextInvariant |
contextInvariant.exists() implies type = 'Extension'
|
| sdf-19 | error | StructureDefinition |
FHIR Specification models only use FHIR defined types Requirements: custom types only in logical models |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\.]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')))
|
| sdf-20 | error | StructureDefinition.differential |
No slicing on the root element Requirements: no slicing on root |
element.where(path.contains('.').not()).slicing.empty()
|
| sdf-21 | error | StructureDefinition |
Default values can only be specified on specializations Requirements: no default values on data types or resources |
differential.element.defaultValue.exists() implies (derivation = 'specialization')
|
| sdf-22 | error | StructureDefinition |
FHIR Specification models never have default values Requirements: no default values on data types or resources |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())
|
| sdf-23 | error | StructureDefinition |
No slice name on root Requirements: no sliceName on root |
(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())
|
| sdf-8a | error | StructureDefinition.differential | In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models |
(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\..*','')&'.')))
|
This structure is derived from StructureDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| StructureDefinition |
0..* | StructureDefinition | Structural Definition | |
 title |
1..1 | string | Name for this structure definition (human friendly) | |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| description |
1..1 | markdown | Natural language description of the structure definition | |
| kind |
1..1 | code | primitive-type | complex-type | resource | logical Required Pattern: logical (extensions allowed) | |
| differential |
||||
| element |
||||
| Slices for code |
1..* | Coding | Corresponding codes in terminologies Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| code:smart |
1..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart (extensions allowed) | |
| code:loinc |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/loinc (extensions allowed) | |
| code:snomed |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/snomed (extensions allowed) | |
| code:icd-10 |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-10 (extensions allowed) | |
| code:icd-11 |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-11 (extensions allowed) | |
| code:icf |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icf (extensions allowed) | |
| code:ichi |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/ichi (extensions allowed) | |
| code:snomed-gps |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart-gps (extensions allowed) | |
| code:atc |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/atc (extensions allowed) | |
| short |
1..1 | string | Concise definition for space-constrained presentation | |
| definition |
1..1 | markdown | Full formal definition as narrative text | |
| type |
1..1 | Element | Data type and Profile for this element | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| StructureDefinition |
C | 0..* | StructureDefinition | Structural Definition Constraints: sdf-0, sdf-1, sdf-15a, sdf-4, sdf-5, sdf-6, sdf-9, sdf-11, sdf-14, sdf-15, sdf-16, sdf-17, sdf-18, sdf-19, sdf-21, sdf-22, sdf-23 | ||||
| id |
0..1 | id | 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 Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 |
C | 1..1 | string | Name for this structure definition (computer friendly) | ||||
| title |
1..1 | string | Name for this structure definition (human friendly) | |||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
1..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) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
| 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 Binding: DefinitionUseCodes (extensible): Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example). | |||||
| fhirVersion |
0..1 | code | FHIR Version this StructureDefinition targets Binding: FHIRVersion (required): All published FHIR Versions. | |||||
| mapping |
C | 0..* | BackboneElement | External specification that the content is mapped to Constraints: sdf-2 | ||||
| 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 |
C | 0..1 | uri | Identifies what this mapping refers to | ||||
| name |
C | 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 Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical (extensions allowed) | |||||
| abstract |
1..1 | boolean | Whether the structure is abstract | |||||
| context |
C | 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 Binding: ExtensionContextType (required): How an extension context is interpreted. | |||||
| expression |
1..1 | string | Where the extension can be used in instances | |||||
| contextInvariant |
C | 0..* | string | FHIRPath invariants - when the extension can be used | ||||
| type |
C | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| baseDefinition |
C | 0..1 | canonical(StructureDefinition) | Definition that this type is constrained/specialized from | ||||
| derivation |
0..1 | code | specialization | constraint - How relates to base definition Binding: TypeDerivationRule (required): How a type relates to its baseDefinition. | |||||
| snapshot |
C | 0..1 | BackboneElement | Snapshot view of the structure Constraints: sdf-3, sdf-8, sdf-8b | ||||
| 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 |
C | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) Constraints: sdf-10 | ||||
| differential |
C | 0..1 | BackboneElement | Differential view of the structure Constraints: sdf-20, sdf-8a | ||||
| 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) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| path |
1..1 | string | Path of the element in the hierarchy of elements | |||||
| representation |
0..* | code | xmlAttr | xmlText | typeAttr | cdaText | xhtml Binding: PropertyRepresentation (required): How a property is represented when serialized. | |||||
| sliceName |
0..1 | string | Name for this particular element (in a set of slices) | |||||
| sliceIsConstraining |
0..1 | boolean | If this slice definition constrains an inherited slice definition (or not) | |||||
| label |
0..1 | string | Name for element to display with or prompt for element | |||||
| Slices for code |
1..* | Coding | Corresponding codes in terminologies Slice: Unordered, Open by pattern:system Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| code:smart |
1..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:loinc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/loinc (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:snomed |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/snomed (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:icd-10 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-10 (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:icd-11 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-11 (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:icf |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icf (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:ichi |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/ichi (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:snomed-gps |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart-gps (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:atc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/atc (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| slicing |
C | 0..1 | Element | This element is sliced - slices follow Constraints: eld-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| discriminator |
0..* | Element | Element values that are used to distinguish the slices | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
1..1 | code | value | exists | pattern | type | profile Binding: DiscriminatorType (required): How an element value is interpreted when discrimination is evaluated. | |||||
| path |
1..1 | string | Path to element value | |||||
| description |
C | 0..1 | string | Text description of how slicing works (or not) | ||||
| ordered |
0..1 | boolean | If elements must be in same order as slices | |||||
| rules |
1..1 | code | closed | open | openAtEnd Binding: SlicingRules (required): How slices are interpreted when evaluating an instance. | |||||
| short |
1..1 | string | Concise definition for space-constrained presentation | |||||
| definition |
1..1 | markdown | Full formal definition as narrative text | |||||
| comment |
0..1 | markdown | Comments about the use of this element | |||||
| requirements |
0..1 | markdown | Why this resource has been created | |||||
| alias |
0..* | string | Other names | |||||
| min |
C | 0..1 | unsignedInt | Minimum Cardinality | ||||
| max |
C | 0..1 | string | Maximum Cardinality (a number or *) Constraints: eld-3 | ||||
| base |
0..1 | Element | Base definition information for tools | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
1..1 | string | Path that identifies the base element | |||||
| min |
1..1 | unsignedInt | Min cardinality of the base element | |||||
| max |
1..1 | string | Max cardinality of the base element | |||||
| contentReference |
C | 0..1 | uri | Reference to definition of content for the element | ||||
| type |
C | 1..1 | Element | Data type and Profile for this element Constraints: eld-4, eld-17 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
1..1 | uri | Data type or Resource (reference to definition) Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | |||||
| profile |
0..* | canonical(StructureDefinition | ImplementationGuide) | Profiles (StructureDefinition or IG) - one must apply | |||||
| targetProfile |
0..* | canonical(StructureDefinition | ImplementationGuide) | Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply | |||||
| aggregation |
C | 0..* | code | contained | referenced | bundled - how aggregated Binding: AggregationMode (required): How resource references can be aggregated. | ||||
| versioning |
0..1 | code | either | independent | specific Binding: ReferenceVersionRules (required): Whether a reference needs to be version specific or version independent, or whether either can be used. | |||||
| defaultValue[x] |
C | 0..1 | Specified value if missing from instance | |||||
| defaultValueBase64Binary |
base64Binary | |||||||
| defaultValueBoolean |
boolean | |||||||
| defaultValueCanonical |
canonical(Any) | |||||||
| defaultValueCode |
code | |||||||
| defaultValueDate |
date | |||||||
| defaultValueDateTime |
dateTime | |||||||
| defaultValueDecimal |
decimal | |||||||
| defaultValueId |
id | |||||||
| defaultValueInstant |
instant | |||||||
| defaultValueInteger |
integer | |||||||
| defaultValueMarkdown |
markdown | |||||||
| defaultValueOid |
oid | |||||||
| defaultValuePositiveInt |
positiveInt | |||||||
| defaultValueString |
string | |||||||
| defaultValueTime |
time | |||||||
| defaultValueUnsignedInt |
unsignedInt | |||||||
| defaultValueUri |
uri | |||||||
| defaultValueUrl |
url | |||||||
| defaultValueUuid |
uuid | |||||||
| defaultValueAddress |
Address | |||||||
| defaultValueAge |
Age | |||||||
| defaultValueAnnotation |
Annotation | |||||||
| defaultValueAttachment |
Attachment | |||||||
| defaultValueCodeableConcept |
CodeableConcept | |||||||
| defaultValueCoding |
Coding | |||||||
| defaultValueContactPoint |
ContactPoint | |||||||
| defaultValueCount |
Count | |||||||
| defaultValueDistance |
Distance | |||||||
| defaultValueDuration |
Duration | |||||||
| defaultValueHumanName |
HumanName | |||||||
| defaultValueIdentifier |
Identifier | |||||||
| defaultValueMoney |
Money | |||||||
| defaultValuePeriod |
Period | |||||||
| defaultValueQuantity |
Quantity | |||||||
| defaultValueRange |
Range | |||||||
| defaultValueRatio |
Ratio | |||||||
| defaultValueReference |
Reference(Any) | |||||||
| defaultValueSampledData |
SampledData | |||||||
| defaultValueSignature |
Signature | |||||||
| defaultValueTiming |
Timing | |||||||
| defaultValueContactDetail |
ContactDetail | |||||||
| defaultValueContributor |
Contributor | |||||||
| defaultValueDataRequirement |
DataRequirement | |||||||
| defaultValueExpression |
Expression | |||||||
| defaultValueParameterDefinition |
ParameterDefinition | |||||||
| defaultValueRelatedArtifact |
RelatedArtifact | |||||||
| defaultValueTriggerDefinition |
TriggerDefinition | |||||||
| defaultValueUsageContext |
UsageContext | |||||||
| defaultValueDosage |
Dosage | |||||||
| defaultValueMeta |
Meta | |||||||
| meaningWhenMissing |
C | 0..1 | markdown | Implicit meaning when this element is missing | ||||
| orderMeaning |
0..1 | string | What the order of the elements means | |||||
| fixed[x] |
C | 0..1 | Value must be exactly this | |||||
| fixedBase64Binary |
base64Binary | |||||||
| fixedBoolean |
boolean | |||||||
| fixedCanonical |
canonical(Any) | |||||||
| fixedCode |
code | |||||||
| fixedDate |
date | |||||||
| fixedDateTime |
dateTime | |||||||
| fixedDecimal |
decimal | |||||||
| fixedId |
id | |||||||
| fixedInstant |
instant | |||||||
| fixedInteger |
integer | |||||||
| fixedMarkdown |
markdown | |||||||
| fixedOid |
oid | |||||||
| fixedPositiveInt |
positiveInt | |||||||
| fixedString |
string | |||||||
| fixedTime |
time | |||||||
| fixedUnsignedInt |
unsignedInt | |||||||
| fixedUri |
uri | |||||||
| fixedUrl |
url | |||||||
| fixedUuid |
uuid | |||||||
| fixedAddress |
Address | |||||||
| fixedAge |
Age | |||||||
| fixedAnnotation |
Annotation | |||||||
| fixedAttachment |
Attachment | |||||||
| fixedCodeableConcept |
CodeableConcept | |||||||
| fixedCoding |
Coding | |||||||
| fixedContactPoint |
ContactPoint | |||||||
| fixedCount |
Count | |||||||
| fixedDistance |
Distance | |||||||
| fixedDuration |
Duration | |||||||
| fixedHumanName |
HumanName | |||||||
| fixedIdentifier |
Identifier | |||||||
| fixedMoney |
Money | |||||||
| fixedPeriod |
Period | |||||||
| fixedQuantity |
Quantity | |||||||
| fixedRange |
Range | |||||||
| fixedRatio |
Ratio | |||||||
| fixedReference |
Reference(Any) | |||||||
| fixedSampledData |
SampledData | |||||||
| fixedSignature |
Signature | |||||||
| fixedTiming |
Timing | |||||||
| fixedContactDetail |
ContactDetail | |||||||
| fixedContributor |
Contributor | |||||||
| fixedDataRequirement |
DataRequirement | |||||||
| fixedExpression |
Expression | |||||||
| fixedParameterDefinition |
ParameterDefinition | |||||||
| fixedRelatedArtifact |
RelatedArtifact | |||||||
| fixedTriggerDefinition |
TriggerDefinition | |||||||
| fixedUsageContext |
UsageContext | |||||||
| fixedDosage |
Dosage | |||||||
| fixedMeta |
Meta | |||||||
| pattern[x] |
C | 0..1 | Value must have at least these property values | |||||
| patternBase64Binary |
base64Binary | |||||||
| patternBoolean |
boolean | |||||||
| patternCanonical |
canonical(Any) | |||||||
| patternCode |
code | |||||||
| patternDate |
date | |||||||
| patternDateTime |
dateTime | |||||||
| patternDecimal |
decimal | |||||||
| patternId |
id | |||||||
| patternInstant |
instant | |||||||
| patternInteger |
integer | |||||||
| patternMarkdown |
markdown | |||||||
| patternOid |
oid | |||||||
| patternPositiveInt |
positiveInt | |||||||
| patternString |
string | |||||||
| patternTime |
time | |||||||
| patternUnsignedInt |
unsignedInt | |||||||
| patternUri |
uri | |||||||
| patternUrl |
url | |||||||
| patternUuid |
uuid | |||||||
| patternAddress |
Address | |||||||
| patternAge |
Age | |||||||
| patternAnnotation |
Annotation | |||||||
| patternAttachment |
Attachment | |||||||
| patternCodeableConcept |
CodeableConcept | |||||||
| patternCoding |
Coding | |||||||
| patternContactPoint |
ContactPoint | |||||||
| patternCount |
Count | |||||||
| patternDistance |
Distance | |||||||
| patternDuration |
Duration | |||||||
| patternHumanName |
HumanName | |||||||
| patternIdentifier |
Identifier | |||||||
| patternMoney |
Money | |||||||
| patternPeriod |
Period | |||||||
| patternQuantity |
Quantity | |||||||
| patternRange |
Range | |||||||
| patternRatio |
Ratio | |||||||
| patternReference |
Reference(Any) | |||||||
| patternSampledData |
SampledData | |||||||
| patternSignature |
Signature | |||||||
| patternTiming |
Timing | |||||||
| patternContactDetail |
ContactDetail | |||||||
| patternContributor |
Contributor | |||||||
| patternDataRequirement |
DataRequirement | |||||||
| patternExpression |
Expression | |||||||
| patternParameterDefinition |
ParameterDefinition | |||||||
| patternRelatedArtifact |
RelatedArtifact | |||||||
| patternTriggerDefinition |
TriggerDefinition | |||||||
| patternUsageContext |
UsageContext | |||||||
| patternDosage |
Dosage | |||||||
| patternMeta |
Meta | |||||||
| example |
0..* | Element | Example value (as defined for type) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| label |
1..1 | string | Describes the purpose of this example | |||||
| value[x] |
1..1 | Value of Example (one of allowed types) | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| minValue[x] |
0..1 | Minimum Allowed Value (for some types) | ||||||
| minValueDate |
date | |||||||
| minValueDateTime |
dateTime | |||||||
| minValueInstant |
instant | |||||||
| minValueTime |
time | |||||||
| minValueDecimal |
decimal | |||||||
| minValueInteger |
integer | |||||||
| minValuePositiveInt |
positiveInt | |||||||
| minValueUnsignedInt |
unsignedInt | |||||||
| minValueQuantity |
Quantity | |||||||
| maxValue[x] |
0..1 | Maximum Allowed Value (for some types) | ||||||
| maxValueDate |
date | |||||||
| maxValueDateTime |
dateTime | |||||||
| maxValueInstant |
instant | |||||||
| maxValueTime |
time | |||||||
| maxValueDecimal |
decimal | |||||||
| maxValueInteger |
integer | |||||||
| maxValuePositiveInt |
positiveInt | |||||||
| maxValueUnsignedInt |
unsignedInt | |||||||
| maxValueQuantity |
Quantity | |||||||
| maxLength |
0..1 | integer | Max length for strings | |||||
| condition |
0..* | id | Reference to invariant about presence | |||||
| constraint |
C | 0..* | Element | Condition that must evaluate to true Constraints: eld-21 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| key |
C | 1..1 | id | Target of 'condition' reference above | ||||
| requirements |
0..1 | string | Why this constraint is necessary or appropriate | |||||
| severity |
1..1 | code | error | warning Binding: ConstraintSeverity (required): SHALL applications comply with this constraint? | |||||
| human |
1..1 | string | Human description of constraint | |||||
| expression |
0..1 | string | FHIRPath expression of constraint | |||||
| xpath |
0..1 | string | XPath expression of constraint | |||||
| source |
0..1 | canonical(StructureDefinition) | Reference to original source of constraint | |||||
| mustSupport |
0..1 | boolean | If the element must be supported | |||||
| isModifier |
0..1 | boolean | If this modifies the meaning of other elements | |||||
| isModifierReason |
0..1 | string | Reason that this element is marked as a modifier | |||||
| isSummary |
0..1 | boolean | Include when _summary = true? | |||||
| binding |
C | 0..1 | Element | ValueSet details if this is coded Constraints: eld-12 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| strength |
1..1 | code | required | extensible | preferred | example Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding. | |||||
| description |
0..1 | string | Human explanation of the value set | |||||
| valueSet |
C | 0..1 | canonical(ValueSet) | Source of value set | ||||
| mapping |
0..* | Element | Map element to another set of definitions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identity |
1..1 | id | Reference to mapping declaration | |||||
| language |
0..1 | code | Computable language of mapping Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||
| map |
1..1 | string | Details of the mapping | |||||
| comment |
0..1 | string | Comments about the mapping or its use | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| StructureDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| StructureDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| StructureDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| StructureDefinition.keyword | Base | extensible | Structure Definition Use Codes / Keywords | 📍4.0.1 | FHIR Std. |
| StructureDefinition.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| StructureDefinition.kind | Base | required | StructureDefinitionKind | 📍4.0.1 | FHIR Std. |
| StructureDefinition.context.type | Base | required | ExtensionContextType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.type | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.derivation | Base | required | TypeDerivationRule | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.representation | Base | required | PropertyRepresentation | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:smart | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:loinc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-10 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-11 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icf | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:ichi | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed-gps | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:atc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.slicing.discriminator.type | Base | required | DiscriminatorType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.slicing.rules | Base | required | SlicingRules | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.code | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.aggregation | Base | required | AggregationMode | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.versioning | Base | required | ReferenceVersionRules | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.constraint.severity | Base | required | ConstraintSeverity | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.binding.strength | Base | required | BindingStrength | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.mapping.language | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | StructureDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | StructureDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | StructureDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| eld-1 | error | StructureDefinition.differential.element.slicing | If there are no discriminators, there must be a definition |
discriminator.exists() or description.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| eld-3 | error | StructureDefinition.differential.element.max | Max SHALL be a number or "*" |
empty() or ($this = '*') or (toInteger() >= 0)
|
| eld-4 | error | StructureDefinition.differential.element.type | Aggregation may only be specified if one of the allowed types for the element is a reference |
aggregation.empty() or (code = 'Reference') or (code = 'canonical')
|
| eld-12 | error | StructureDefinition.differential.element.binding | ValueSet SHALL start with http:// or https:// or urn: |
valueSet.exists() implies (valueSet.startsWith('http:') or valueSet.startsWith('https') or valueSet.startsWith('urn:'))
|
| eld-17 | error | StructureDefinition.differential.element.type | targetProfile is only allowed if the type is Reference or canonical |
(code='Reference' or code = 'canonical') or targetProfile.empty()
|
| eld-21 | warning | StructureDefinition.differential.element.constraint | Constraints should have an expression or else validators will not be able to enforce them |
expression.exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sdf-0 | warning | StructureDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| sdf-1 | error | StructureDefinition | Element paths must be unique unless the structure is a constraint |
derivation = 'constraint' or snapshot.element.select(path).isDistinct()
|
| sdf-15a | error | StructureDefinition |
If the first element in a differential has no "." in the path and it's not a logical model, it has no type Requirements: No Type on the root element (differential) |
(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()
|
| sdf-2 | error | StructureDefinition.mapping | Must have at least a name or a uri (or both) |
name.exists() or uri.exists()
|
| sdf-3 | error | StructureDefinition.snapshot | Each element definition in a snapshot must have a formal definition and cardinalities |
element.all(definition.exists() and min.exists() and max.exists())
|
| sdf-4 | error | StructureDefinition |
If the structure is not abstract, then there SHALL be a baseDefinition Requirements: Ensure that the base types are abstract |
abstract = true or baseDefinition.exists()
|
| sdf-5 | error | StructureDefinition | If the structure defines an extension then the structure must have context information |
type != 'Extension' or derivation = 'specialization' or (context.exists())
|
| sdf-6 | error | StructureDefinition | A structure must have either a differential, or a snapshot (or both) |
snapshot.exists() or differential.exists()
|
| sdf-8 | error | StructureDefinition.snapshot | All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models |
(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))
|
| sdf-10 | error | StructureDefinition.snapshot.element |
provide either a binding reference or a description (or both) Requirements: binding is required |
binding.empty() or binding.valueSet.exists() or binding.description.exists()
|
| sdf-11 | error | StructureDefinition |
If there's a type, its content must match the path name in the first element of a snapshot Requirements: Ensure that the type is not inconsistent with the other information in the structure |
kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type
|
| sdf-14 | error | StructureDefinition |
All element definitions must have an id Requirements: elements have id |
snapshot.element.all(id.exists()) and differential.element.all(id.exists())
|
| sdf-15 | error | StructureDefinition |
The first element in a snapshot has no type unless model is a logical model. Requirements: No Type on the root element (snapshot) |
kind!='logical' implies snapshot.element.first().type.empty()
|
| sdf-16 | error | StructureDefinition |
All element definitions must have unique ids (snapshot) Requirements: element ids need to be unique |
snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()
|
| sdf-17 | error | StructureDefinition |
All element definitions must have unique ids (diff) Requirements: element ids need to be unique |
differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()
|
| sdf-18 | error | StructureDefinition |
Context Invariants can only be used for extensions Requirements: contextInvariant |
contextInvariant.exists() implies type = 'Extension'
|
| sdf-8a | error | StructureDefinition.differential | In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models |
(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\..*','')&'.')))
|
| sdf-9 | error | StructureDefinition |
In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element) Requirements: Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition |
children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()
|
| sdf-19 | error | StructureDefinition |
FHIR Specification models only use FHIR defined types Requirements: custom types only in logical models |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\.]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')))
|
| sdf-20 | error | StructureDefinition.differential |
No slicing on the root element Requirements: no slicing on root |
element.where(path.contains('.').not()).slicing.empty()
|
| sdf-21 | error | StructureDefinition |
Default values can only be specified on specializations Requirements: no default values on data types or resources |
differential.element.defaultValue.exists() implies (derivation = 'specialization')
|
| sdf-22 | error | StructureDefinition |
FHIR Specification models never have default values Requirements: no default values on data types or resources |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())
|
| sdf-23 | error | StructureDefinition |
No slice name on root Requirements: no sliceName on root |
(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())
|
| sdf-8b | error | StructureDefinition.snapshot | All snapshot elements must have a base definition |
element.all(base.exists())
|
This structure is derived from StructureDefinition
Summary
Mandatory: 3 elements(14 nested mandatory elements)
Must-Support: 9 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of StructureDefinition.differential.element.code
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| StructureDefinition |
C | 0..* | StructureDefinition | Structural Definition Constraints: sdf-0, sdf-1, sdf-15a, sdf-4, sdf-5, sdf-6, sdf-9, sdf-11, sdf-14, sdf-15, sdf-16, sdf-17, sdf-18, sdf-19, sdf-21, sdf-22, sdf-23 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| url |
1..1 | uri | Canonical identifier for this structure definition, represented as a URI (globally unique) | |
| name |
C | 1..1 | string | Name for this structure definition (computer friendly) |
| title |
1..1 | string | Name for this structure definition (human friendly) | |
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| description |
1..1 | markdown | Natural language description of the structure definition | |
| kind |
1..1 | code | primitive-type | complex-type | resource | logical Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical (extensions allowed) | |
| abstract |
1..1 | boolean | Whether the structure is abstract | |
| type |
C | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. |
| differential |
C | 0..1 | BackboneElement | Differential view of the structure Constraints: sdf-20, sdf-8a |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| element |
1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| path |
1..1 | string | Path of the element in the hierarchy of elements | |
| Slices for code |
1..* | Coding | Corresponding codes in terminologies Slice: Unordered, Open by pattern:system Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| code:smart |
1..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart (extensions allowed) | |
| code:loinc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/loinc (extensions allowed) | |
| code:snomed |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/snomed (extensions allowed) | |
| code:icd-10 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-10 (extensions allowed) | |
| code:icd-11 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-11 (extensions allowed) | |
| code:icf |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icf (extensions allowed) | |
| code:ichi |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/ichi (extensions allowed) | |
| code:snomed-gps |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart-gps (extensions allowed) | |
| code:atc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/atc (extensions allowed) | |
| short |
1..1 | string | Concise definition for space-constrained presentation | |
| definition |
1..1 | markdown | Full formal definition as narrative text | |
| max |
C | 0..1 | string | Maximum Cardinality (a number or *) Constraints: eld-3 |
| type |
C | 1..1 | Element | Data type and Profile for this element Constraints: eld-4, eld-17 |
| code |
1..1 | uri | Data type or Resource (reference to definition) Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | |
| fixed[x] |
C | 0..1 | Value must be exactly this | |
| fixedBase64Binary |
base64Binary | |||
| fixedBoolean |
boolean | |||
| fixedCanonical |
canonical(Any) | |||
| fixedCode |
code | |||
| fixedDate |
date | |||
| fixedDateTime |
dateTime | |||
| fixedDecimal |
decimal | |||
| fixedId |
id | |||
| fixedInstant |
instant | |||
| fixedInteger |
integer | |||
| fixedMarkdown |
markdown | |||
| fixedOid |
oid | |||
| fixedPositiveInt |
positiveInt | |||
| fixedString |
string | |||
| fixedTime |
time | |||
| fixedUnsignedInt |
unsignedInt | |||
| fixedUri |
uri | |||
| fixedUrl |
url | |||
| fixedUuid |
uuid | |||
| fixedAddress |
Address | |||
| fixedAge |
Age | |||
| fixedAnnotation |
Annotation | |||
| fixedAttachment |
Attachment | |||
| fixedCodeableConcept |
CodeableConcept | |||
| fixedCoding |
Coding | |||
| fixedContactPoint |
ContactPoint | |||
| fixedCount |
Count | |||
| fixedDistance |
Distance | |||
| fixedDuration |
Duration | |||
| fixedHumanName |
HumanName | |||
| fixedIdentifier |
Identifier | |||
| fixedMoney |
Money | |||
| fixedPeriod |
Period | |||
| fixedQuantity |
Quantity | |||
| fixedRange |
Range | |||
| fixedRatio |
Ratio | |||
| fixedReference |
Reference(Any) | |||
| fixedSampledData |
SampledData | |||
| fixedSignature |
Signature | |||
| fixedTiming |
Timing | |||
| fixedContactDetail |
ContactDetail | |||
| fixedContributor |
Contributor | |||
| fixedDataRequirement |
DataRequirement | |||
| fixedExpression |
Expression | |||
| fixedParameterDefinition |
ParameterDefinition | |||
| fixedRelatedArtifact |
RelatedArtifact | |||
| fixedTriggerDefinition |
TriggerDefinition | |||
| fixedUsageContext |
UsageContext | |||
| fixedDosage |
Dosage | |||
| fixedMeta |
Meta | |||
| pattern[x] |
C | 0..1 | Value must have at least these property values | |
| patternBase64Binary |
base64Binary | |||
| patternBoolean |
boolean | |||
| patternCanonical |
canonical(Any) | |||
| patternCode |
code | |||
| patternDate |
date | |||
| patternDateTime |
dateTime | |||
| patternDecimal |
decimal | |||
| patternId |
id | |||
| patternInstant |
instant | |||
| patternInteger |
integer | |||
| patternMarkdown |
markdown | |||
| patternOid |
oid | |||
| patternPositiveInt |
positiveInt | |||
| patternString |
string | |||
| patternTime |
time | |||
| patternUnsignedInt |
unsignedInt | |||
| patternUri |
uri | |||
| patternUrl |
url | |||
| patternUuid |
uuid | |||
| patternAddress |
Address | |||
| patternAge |
Age | |||
| patternAnnotation |
Annotation | |||
| patternAttachment |
Attachment | |||
| patternCodeableConcept |
CodeableConcept | |||
| patternCoding |
Coding | |||
| patternContactPoint |
ContactPoint | |||
| patternCount |
Count | |||
| patternDistance |
Distance | |||
| patternDuration |
Duration | |||
| patternHumanName |
HumanName | |||
| patternIdentifier |
Identifier | |||
| patternMoney |
Money | |||
| patternPeriod |
Period | |||
| patternQuantity |
Quantity | |||
| patternRange |
Range | |||
| patternRatio |
Ratio | |||
| patternReference |
Reference(Any) | |||
| patternSampledData |
SampledData | |||
| patternSignature |
Signature | |||
| patternTiming |
Timing | |||
| patternContactDetail |
ContactDetail | |||
| patternContributor |
Contributor | |||
| patternDataRequirement |
DataRequirement | |||
| patternExpression |
Expression | |||
| patternParameterDefinition |
ParameterDefinition | |||
| patternRelatedArtifact |
RelatedArtifact | |||
| patternTriggerDefinition |
TriggerDefinition | |||
| patternUsageContext |
UsageContext | |||
| patternDosage |
Dosage | |||
| patternMeta |
Meta | |||
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| StructureDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| StructureDefinition.kind | Base | required | StructureDefinitionKind | 📍4.0.1 | FHIR Std. |
| StructureDefinition.type | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:smart | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:loinc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-10 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-11 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icf | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:ichi | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed-gps | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:atc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.code | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | StructureDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | StructureDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | StructureDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| eld-3 | error | StructureDefinition.differential.element.max | Max SHALL be a number or "*" |
empty() or ($this = '*') or (toInteger() >= 0)
|
| eld-4 | error | StructureDefinition.differential.element.type | Aggregation may only be specified if one of the allowed types for the element is a reference |
aggregation.empty() or (code = 'Reference') or (code = 'canonical')
|
| eld-17 | error | StructureDefinition.differential.element.type | targetProfile is only allowed if the type is Reference or canonical |
(code='Reference' or code = 'canonical') or targetProfile.empty()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sdf-0 | warning | StructureDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| sdf-1 | error | StructureDefinition | Element paths must be unique unless the structure is a constraint |
derivation = 'constraint' or snapshot.element.select(path).isDistinct()
|
| sdf-4 | error | StructureDefinition |
If the structure is not abstract, then there SHALL be a baseDefinition Requirements: Ensure that the base types are abstract |
abstract = true or baseDefinition.exists()
|
| sdf-5 | error | StructureDefinition | If the structure defines an extension then the structure must have context information |
type != 'Extension' or derivation = 'specialization' or (context.exists())
|
| sdf-6 | error | StructureDefinition | A structure must have either a differential, or a snapshot (or both) |
snapshot.exists() or differential.exists()
|
| sdf-9 | error | StructureDefinition |
In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element) Requirements: Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition |
children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()
|
| sdf-11 | error | StructureDefinition |
If there's a type, its content must match the path name in the first element of a snapshot Requirements: Ensure that the type is not inconsistent with the other information in the structure |
kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type
|
| sdf-14 | error | StructureDefinition |
All element definitions must have an id Requirements: elements have id |
snapshot.element.all(id.exists()) and differential.element.all(id.exists())
|
| sdf-15 | error | StructureDefinition |
The first element in a snapshot has no type unless model is a logical model. Requirements: No Type on the root element (snapshot) |
kind!='logical' implies snapshot.element.first().type.empty()
|
| sdf-15a | error | StructureDefinition |
If the first element in a differential has no "." in the path and it's not a logical model, it has no type Requirements: No Type on the root element (differential) |
(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()
|
| sdf-16 | error | StructureDefinition |
All element definitions must have unique ids (snapshot) Requirements: element ids need to be unique |
snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()
|
| sdf-17 | error | StructureDefinition |
All element definitions must have unique ids (diff) Requirements: element ids need to be unique |
differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()
|
| sdf-18 | error | StructureDefinition |
Context Invariants can only be used for extensions Requirements: contextInvariant |
contextInvariant.exists() implies type = 'Extension'
|
| sdf-19 | error | StructureDefinition |
FHIR Specification models only use FHIR defined types Requirements: custom types only in logical models |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\.]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')))
|
| sdf-20 | error | StructureDefinition.differential |
No slicing on the root element Requirements: no slicing on root |
element.where(path.contains('.').not()).slicing.empty()
|
| sdf-21 | error | StructureDefinition |
Default values can only be specified on specializations Requirements: no default values on data types or resources |
differential.element.defaultValue.exists() implies (derivation = 'specialization')
|
| sdf-22 | error | StructureDefinition |
FHIR Specification models never have default values Requirements: no default values on data types or resources |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())
|
| sdf-23 | error | StructureDefinition |
No slice name on root Requirements: no sliceName on root |
(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())
|
| sdf-8a | error | StructureDefinition.differential | In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models |
(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\..*','')&'.')))
|
Differential View
This structure is derived from StructureDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| StructureDefinition |
0..* | StructureDefinition | Structural Definition | |
| title |
1..1 | string | Name for this structure definition (human friendly) | |
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |
| description |
1..1 | markdown | Natural language description of the structure definition | |
| kind |
1..1 | code | primitive-type | complex-type | resource | logical Required Pattern: logical (extensions allowed) | |
| differential |
||||
| element |
||||
| Slices for code |
1..* | Coding | Corresponding codes in terminologies Slice: Unordered, Open by pattern:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| code:smart |
1..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart (extensions allowed) | |
| code:loinc |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/loinc (extensions allowed) | |
| code:snomed |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/snomed (extensions allowed) | |
| code:icd-10 |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-10 (extensions allowed) | |
| code:icd-11 |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-11 (extensions allowed) | |
| code:icf |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icf (extensions allowed) | |
| code:ichi |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/ichi (extensions allowed) | |
| code:snomed-gps |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart-gps (extensions allowed) | |
| code:atc |
0..1 | Coding | Corresponding codes in terminologies | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/atc (extensions allowed) | |
| short |
1..1 | string | Concise definition for space-constrained presentation | |
| definition |
1..1 | markdown | Full formal definition as narrative text | |
| type |
1..1 | Element | Data type and Profile for this element | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| StructureDefinition |
C | 0..* | StructureDefinition | Structural Definition Constraints: sdf-0, sdf-1, sdf-15a, sdf-4, sdf-5, sdf-6, sdf-9, sdf-11, sdf-14, sdf-15, sdf-16, sdf-17, sdf-18, sdf-19, sdf-21, sdf-22, sdf-23 | ||||
| id |
0..1 | id | 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 Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 |
C | 1..1 | string | Name for this structure definition (computer friendly) | ||||
| title |
1..1 | string | Name for this structure definition (human friendly) | |||||
| status |
1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | |||||
| experimental |
0..1 | boolean | For testing purposes, not real usage | |||||
| date |
0..1 | dateTime | Date last changed | |||||
| publisher |
1..1 | string | Name of the publisher (organization or individual) | |||||
| contact |
0..* | ContactDetail | Contact details for the publisher | |||||
| description |
1..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) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | |||||
| 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 Binding: DefinitionUseCodes (extensible): Codes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example). | |||||
| fhirVersion |
0..1 | code | FHIR Version this StructureDefinition targets Binding: FHIRVersion (required): All published FHIR Versions. | |||||
| mapping |
C | 0..* | BackboneElement | External specification that the content is mapped to Constraints: sdf-2 | ||||
| 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 |
C | 0..1 | uri | Identifies what this mapping refers to | ||||
| name |
C | 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 Binding: StructureDefinitionKind (required): Defines the type of structure that a definition is describing. Required Pattern: logical (extensions allowed) | |||||
| abstract |
1..1 | boolean | Whether the structure is abstract | |||||
| context |
C | 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 Binding: ExtensionContextType (required): How an extension context is interpreted. | |||||
| expression |
1..1 | string | Where the extension can be used in instances | |||||
| contextInvariant |
C | 0..* | string | FHIRPath invariants - when the extension can be used | ||||
| type |
C | 1..1 | uri | Type defined or constrained by this structure Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | ||||
| baseDefinition |
C | 0..1 | canonical(StructureDefinition) | Definition that this type is constrained/specialized from | ||||
| derivation |
0..1 | code | specialization | constraint - How relates to base definition Binding: TypeDerivationRule (required): How a type relates to its baseDefinition. | |||||
| snapshot |
C | 0..1 | BackboneElement | Snapshot view of the structure Constraints: sdf-3, sdf-8, sdf-8b | ||||
| 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 |
C | 1..* | ElementDefinition | Definition of elements in the resource (if no StructureDefinition) Constraints: sdf-10 | ||||
| differential |
C | 0..1 | BackboneElement | Differential view of the structure Constraints: sdf-20, sdf-8a | ||||
| 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) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| path |
1..1 | string | Path of the element in the hierarchy of elements | |||||
| representation |
0..* | code | xmlAttr | xmlText | typeAttr | cdaText | xhtml Binding: PropertyRepresentation (required): How a property is represented when serialized. | |||||
| sliceName |
0..1 | string | Name for this particular element (in a set of slices) | |||||
| sliceIsConstraining |
0..1 | boolean | If this slice definition constrains an inherited slice definition (or not) | |||||
| label |
0..1 | string | Name for element to display with or prompt for element | |||||
| Slices for code |
1..* | Coding | Corresponding codes in terminologies Slice: Unordered, Open by pattern:system Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| code:smart |
1..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:loinc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/loinc (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:snomed |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/snomed (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:icd-10 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-10 (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:icd-11 |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icd-11 (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:icf |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/icf (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:ichi |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/ichi (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:snomed-gps |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/smart-gps (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| code:atc |
0..1 | Coding | Corresponding codes in terminologies Binding: LOINCCodes (example): Codes that indicate the meaning of a data element. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://who.smart.codes/atc (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| slicing |
C | 0..1 | Element | This element is sliced - slices follow Constraints: eld-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| discriminator |
0..* | Element | Element values that are used to distinguish the slices | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| type |
1..1 | code | value | exists | pattern | type | profile Binding: DiscriminatorType (required): How an element value is interpreted when discrimination is evaluated. | |||||
| path |
1..1 | string | Path to element value | |||||
| description |
C | 0..1 | string | Text description of how slicing works (or not) | ||||
| ordered |
0..1 | boolean | If elements must be in same order as slices | |||||
| rules |
1..1 | code | closed | open | openAtEnd Binding: SlicingRules (required): How slices are interpreted when evaluating an instance. | |||||
| short |
1..1 | string | Concise definition for space-constrained presentation | |||||
| definition |
1..1 | markdown | Full formal definition as narrative text | |||||
| comment |
0..1 | markdown | Comments about the use of this element | |||||
| requirements |
0..1 | markdown | Why this resource has been created | |||||
| alias |
0..* | string | Other names | |||||
| min |
C | 0..1 | unsignedInt | Minimum Cardinality | ||||
| max |
C | 0..1 | string | Maximum Cardinality (a number or *) Constraints: eld-3 | ||||
| base |
0..1 | Element | Base definition information for tools | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| path |
1..1 | string | Path that identifies the base element | |||||
| min |
1..1 | unsignedInt | Min cardinality of the base element | |||||
| max |
1..1 | string | Max cardinality of the base element | |||||
| contentReference |
C | 0..1 | uri | Reference to definition of content for the element | ||||
| type |
C | 1..1 | Element | Data type and Profile for this element Constraints: eld-4, eld-17 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code |
1..1 | uri | Data type or Resource (reference to definition) Binding: FHIRDefinedType (extensible): Either a resource or a data type, including logical model types. | |||||
| profile |
0..* | canonical(StructureDefinition | ImplementationGuide) | Profiles (StructureDefinition or IG) - one must apply | |||||
| targetProfile |
0..* | canonical(StructureDefinition | ImplementationGuide) | Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply | |||||
| aggregation |
C | 0..* | code | contained | referenced | bundled - how aggregated Binding: AggregationMode (required): How resource references can be aggregated. | ||||
| versioning |
0..1 | code | either | independent | specific Binding: ReferenceVersionRules (required): Whether a reference needs to be version specific or version independent, or whether either can be used. | |||||
| defaultValue[x] |
C | 0..1 | Specified value if missing from instance | |||||
| defaultValueBase64Binary |
base64Binary | |||||||
| defaultValueBoolean |
boolean | |||||||
| defaultValueCanonical |
canonical(Any) | |||||||
| defaultValueCode |
code | |||||||
| defaultValueDate |
date | |||||||
| defaultValueDateTime |
dateTime | |||||||
| defaultValueDecimal |
decimal | |||||||
| defaultValueId |
id | |||||||
| defaultValueInstant |
instant | |||||||
| defaultValueInteger |
integer | |||||||
| defaultValueMarkdown |
markdown | |||||||
| defaultValueOid |
oid | |||||||
| defaultValuePositiveInt |
positiveInt | |||||||
| defaultValueString |
string | |||||||
| defaultValueTime |
time | |||||||
| defaultValueUnsignedInt |
unsignedInt | |||||||
| defaultValueUri |
uri | |||||||
| defaultValueUrl |
url | |||||||
| defaultValueUuid |
uuid | |||||||
| defaultValueAddress |
Address | |||||||
| defaultValueAge |
Age | |||||||
| defaultValueAnnotation |
Annotation | |||||||
| defaultValueAttachment |
Attachment | |||||||
| defaultValueCodeableConcept |
CodeableConcept | |||||||
| defaultValueCoding |
Coding | |||||||
| defaultValueContactPoint |
ContactPoint | |||||||
| defaultValueCount |
Count | |||||||
| defaultValueDistance |
Distance | |||||||
| defaultValueDuration |
Duration | |||||||
| defaultValueHumanName |
HumanName | |||||||
| defaultValueIdentifier |
Identifier | |||||||
| defaultValueMoney |
Money | |||||||
| defaultValuePeriod |
Period | |||||||
| defaultValueQuantity |
Quantity | |||||||
| defaultValueRange |
Range | |||||||
| defaultValueRatio |
Ratio | |||||||
| defaultValueReference |
Reference(Any) | |||||||
| defaultValueSampledData |
SampledData | |||||||
| defaultValueSignature |
Signature | |||||||
| defaultValueTiming |
Timing | |||||||
| defaultValueContactDetail |
ContactDetail | |||||||
| defaultValueContributor |
Contributor | |||||||
| defaultValueDataRequirement |
DataRequirement | |||||||
| defaultValueExpression |
Expression | |||||||
| defaultValueParameterDefinition |
ParameterDefinition | |||||||
| defaultValueRelatedArtifact |
RelatedArtifact | |||||||
| defaultValueTriggerDefinition |
TriggerDefinition | |||||||
| defaultValueUsageContext |
UsageContext | |||||||
| defaultValueDosage |
Dosage | |||||||
| defaultValueMeta |
Meta | |||||||
| meaningWhenMissing |
C | 0..1 | markdown | Implicit meaning when this element is missing | ||||
| orderMeaning |
0..1 | string | What the order of the elements means | |||||
| fixed[x] |
C | 0..1 | Value must be exactly this | |||||
| fixedBase64Binary |
base64Binary | |||||||
| fixedBoolean |
boolean | |||||||
| fixedCanonical |
canonical(Any) | |||||||
| fixedCode |
code | |||||||
| fixedDate |
date | |||||||
| fixedDateTime |
dateTime | |||||||
| fixedDecimal |
decimal | |||||||
| fixedId |
id | |||||||
| fixedInstant |
instant | |||||||
| fixedInteger |
integer | |||||||
| fixedMarkdown |
markdown | |||||||
| fixedOid |
oid | |||||||
| fixedPositiveInt |
positiveInt | |||||||
| fixedString |
string | |||||||
| fixedTime |
time | |||||||
| fixedUnsignedInt |
unsignedInt | |||||||
| fixedUri |
uri | |||||||
| fixedUrl |
url | |||||||
| fixedUuid |
uuid | |||||||
| fixedAddress |
Address | |||||||
| fixedAge |
Age | |||||||
| fixedAnnotation |
Annotation | |||||||
| fixedAttachment |
Attachment | |||||||
| fixedCodeableConcept |
CodeableConcept | |||||||
| fixedCoding |
Coding | |||||||
| fixedContactPoint |
ContactPoint | |||||||
| fixedCount |
Count | |||||||
| fixedDistance |
Distance | |||||||
| fixedDuration |
Duration | |||||||
| fixedHumanName |
HumanName | |||||||
| fixedIdentifier |
Identifier | |||||||
| fixedMoney |
Money | |||||||
| fixedPeriod |
Period | |||||||
| fixedQuantity |
Quantity | |||||||
| fixedRange |
Range | |||||||
| fixedRatio |
Ratio | |||||||
| fixedReference |
Reference(Any) | |||||||
| fixedSampledData |
SampledData | |||||||
| fixedSignature |
Signature | |||||||
| fixedTiming |
Timing | |||||||
| fixedContactDetail |
ContactDetail | |||||||
| fixedContributor |
Contributor | |||||||
| fixedDataRequirement |
DataRequirement | |||||||
| fixedExpression |
Expression | |||||||
| fixedParameterDefinition |
ParameterDefinition | |||||||
| fixedRelatedArtifact |
RelatedArtifact | |||||||
| fixedTriggerDefinition |
TriggerDefinition | |||||||
| fixedUsageContext |
UsageContext | |||||||
| fixedDosage |
Dosage | |||||||
| fixedMeta |
Meta | |||||||
| pattern[x] |
C | 0..1 | Value must have at least these property values | |||||
| patternBase64Binary |
base64Binary | |||||||
| patternBoolean |
boolean | |||||||
| patternCanonical |
canonical(Any) | |||||||
| patternCode |
code | |||||||
| patternDate |
date | |||||||
| patternDateTime |
dateTime | |||||||
| patternDecimal |
decimal | |||||||
| patternId |
id | |||||||
| patternInstant |
instant | |||||||
| patternInteger |
integer | |||||||
| patternMarkdown |
markdown | |||||||
| patternOid |
oid | |||||||
| patternPositiveInt |
positiveInt | |||||||
| patternString |
string | |||||||
| patternTime |
time | |||||||
| patternUnsignedInt |
unsignedInt | |||||||
| patternUri |
uri | |||||||
| patternUrl |
url | |||||||
| patternUuid |
uuid | |||||||
| patternAddress |
Address | |||||||
| patternAge |
Age | |||||||
| patternAnnotation |
Annotation | |||||||
| patternAttachment |
Attachment | |||||||
| patternCodeableConcept |
CodeableConcept | |||||||
| patternCoding |
Coding | |||||||
| patternContactPoint |
ContactPoint | |||||||
| patternCount |
Count | |||||||
| patternDistance |
Distance | |||||||
| patternDuration |
Duration | |||||||
| patternHumanName |
HumanName | |||||||
| patternIdentifier |
Identifier | |||||||
| patternMoney |
Money | |||||||
| patternPeriod |
Period | |||||||
| patternQuantity |
Quantity | |||||||
| patternRange |
Range | |||||||
| patternRatio |
Ratio | |||||||
| patternReference |
Reference(Any) | |||||||
| patternSampledData |
SampledData | |||||||
| patternSignature |
Signature | |||||||
| patternTiming |
Timing | |||||||
| patternContactDetail |
ContactDetail | |||||||
| patternContributor |
Contributor | |||||||
| patternDataRequirement |
DataRequirement | |||||||
| patternExpression |
Expression | |||||||
| patternParameterDefinition |
ParameterDefinition | |||||||
| patternRelatedArtifact |
RelatedArtifact | |||||||
| patternTriggerDefinition |
TriggerDefinition | |||||||
| patternUsageContext |
UsageContext | |||||||
| patternDosage |
Dosage | |||||||
| patternMeta |
Meta | |||||||
| example |
0..* | Element | Example value (as defined for type) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| label |
1..1 | string | Describes the purpose of this example | |||||
| value[x] |
1..1 | Value of Example (one of allowed types) | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| minValue[x] |
0..1 | Minimum Allowed Value (for some types) | ||||||
| minValueDate |
date | |||||||
| minValueDateTime |
dateTime | |||||||
| minValueInstant |
instant | |||||||
| minValueTime |
time | |||||||
| minValueDecimal |
decimal | |||||||
| minValueInteger |
integer | |||||||
| minValuePositiveInt |
positiveInt | |||||||
| minValueUnsignedInt |
unsignedInt | |||||||
| minValueQuantity |
Quantity | |||||||
| maxValue[x] |
0..1 | Maximum Allowed Value (for some types) | ||||||
| maxValueDate |
date | |||||||
| maxValueDateTime |
dateTime | |||||||
| maxValueInstant |
instant | |||||||
| maxValueTime |
time | |||||||
| maxValueDecimal |
decimal | |||||||
| maxValueInteger |
integer | |||||||
| maxValuePositiveInt |
positiveInt | |||||||
| maxValueUnsignedInt |
unsignedInt | |||||||
| maxValueQuantity |
Quantity | |||||||
| maxLength |
0..1 | integer | Max length for strings | |||||
| condition |
0..* | id | Reference to invariant about presence | |||||
| constraint |
C | 0..* | Element | Condition that must evaluate to true Constraints: eld-21 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| key |
C | 1..1 | id | Target of 'condition' reference above | ||||
| requirements |
0..1 | string | Why this constraint is necessary or appropriate | |||||
| severity |
1..1 | code | error | warning Binding: ConstraintSeverity (required): SHALL applications comply with this constraint? | |||||
| human |
1..1 | string | Human description of constraint | |||||
| expression |
0..1 | string | FHIRPath expression of constraint | |||||
| xpath |
0..1 | string | XPath expression of constraint | |||||
| source |
0..1 | canonical(StructureDefinition) | Reference to original source of constraint | |||||
| mustSupport |
0..1 | boolean | If the element must be supported | |||||
| isModifier |
0..1 | boolean | If this modifies the meaning of other elements | |||||
| isModifierReason |
0..1 | string | Reason that this element is marked as a modifier | |||||
| isSummary |
0..1 | boolean | Include when _summary = true? | |||||
| binding |
C | 0..1 | Element | ValueSet details if this is coded Constraints: eld-12 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| strength |
1..1 | code | required | extensible | preferred | example Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding. | |||||
| description |
0..1 | string | Human explanation of the value set | |||||
| valueSet |
C | 0..1 | canonical(ValueSet) | Source of value set | ||||
| mapping |
0..* | Element | Map element to another set of definitions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identity |
1..1 | id | Reference to mapping declaration | |||||
| language |
0..1 | code | Computable language of mapping Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. | |||||
| map |
1..1 | string | Details of the mapping | |||||
| comment |
0..1 | string | Comments about the mapping or its use | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| StructureDefinition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| StructureDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| StructureDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| StructureDefinition.keyword | Base | extensible | Structure Definition Use Codes / Keywords | 📍4.0.1 | FHIR Std. |
| StructureDefinition.fhirVersion | Base | required | FHIRVersion | 📍4.0.1 | FHIR Std. |
| StructureDefinition.kind | Base | required | StructureDefinitionKind | 📍4.0.1 | FHIR Std. |
| StructureDefinition.context.type | Base | required | ExtensionContextType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.type | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.derivation | Base | required | TypeDerivationRule | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.representation | Base | required | PropertyRepresentation | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:smart | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:loinc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-10 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icd-11 | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:icf | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:ichi | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:snomed-gps | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.code:atc | Base | example | LOINC Codes | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.slicing.discriminator.type | Base | required | DiscriminatorType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.slicing.rules | Base | required | SlicingRules | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.code | Base | extensible | FHIRDefinedType | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.aggregation | Base | required | AggregationMode | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.type.versioning | Base | required | ReferenceVersionRules | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.constraint.severity | Base | required | ConstraintSeverity | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.binding.strength | Base | required | BindingStrength | 📍4.0.1 | FHIR Std. |
| StructureDefinition.differential.element.mapping.language | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | StructureDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | StructureDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | StructureDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | StructureDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| eld-1 | error | StructureDefinition.differential.element.slicing | If there are no discriminators, there must be a definition |
discriminator.exists() or description.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| eld-3 | error | StructureDefinition.differential.element.max | Max SHALL be a number or "*" |
empty() or ($this = '*') or (toInteger() >= 0)
|
| eld-4 | error | StructureDefinition.differential.element.type | Aggregation may only be specified if one of the allowed types for the element is a reference |
aggregation.empty() or (code = 'Reference') or (code = 'canonical')
|
| eld-12 | error | StructureDefinition.differential.element.binding | ValueSet SHALL start with http:// or https:// or urn: |
valueSet.exists() implies (valueSet.startsWith('http:') or valueSet.startsWith('https') or valueSet.startsWith('urn:'))
|
| eld-17 | error | StructureDefinition.differential.element.type | targetProfile is only allowed if the type is Reference or canonical |
(code='Reference' or code = 'canonical') or targetProfile.empty()
|
| eld-21 | warning | StructureDefinition.differential.element.constraint | Constraints should have an expression or else validators will not be able to enforce them |
expression.exists()
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| sdf-0 | warning | StructureDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| sdf-1 | error | StructureDefinition | Element paths must be unique unless the structure is a constraint |
derivation = 'constraint' or snapshot.element.select(path).isDistinct()
|
| sdf-15a | error | StructureDefinition |
If the first element in a differential has no "." in the path and it's not a logical model, it has no type Requirements: No Type on the root element (differential) |
(kind!='logical' and differential.element.first().path.contains('.').not()) implies differential.element.first().type.empty()
|
| sdf-2 | error | StructureDefinition.mapping | Must have at least a name or a uri (or both) |
name.exists() or uri.exists()
|
| sdf-3 | error | StructureDefinition.snapshot | Each element definition in a snapshot must have a formal definition and cardinalities |
element.all(definition.exists() and min.exists() and max.exists())
|
| sdf-4 | error | StructureDefinition |
If the structure is not abstract, then there SHALL be a baseDefinition Requirements: Ensure that the base types are abstract |
abstract = true or baseDefinition.exists()
|
| sdf-5 | error | StructureDefinition | If the structure defines an extension then the structure must have context information |
type != 'Extension' or derivation = 'specialization' or (context.exists())
|
| sdf-6 | error | StructureDefinition | A structure must have either a differential, or a snapshot (or both) |
snapshot.exists() or differential.exists()
|
| sdf-8 | error | StructureDefinition.snapshot | All snapshot elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models |
(%resource.kind = 'logical' or element.first().path = %resource.type) and element.tail().all(path.startsWith(%resource.snapshot.element.first().path&'.'))
|
| sdf-10 | error | StructureDefinition.snapshot.element |
provide either a binding reference or a description (or both) Requirements: binding is required |
binding.empty() or binding.valueSet.exists() or binding.description.exists()
|
| sdf-11 | error | StructureDefinition |
If there's a type, its content must match the path name in the first element of a snapshot Requirements: Ensure that the type is not inconsistent with the other information in the structure |
kind != 'logical' implies snapshot.empty() or snapshot.element.first().path = type
|
| sdf-14 | error | StructureDefinition |
All element definitions must have an id Requirements: elements have id |
snapshot.element.all(id.exists()) and differential.element.all(id.exists())
|
| sdf-15 | error | StructureDefinition |
The first element in a snapshot has no type unless model is a logical model. Requirements: No Type on the root element (snapshot) |
kind!='logical' implies snapshot.element.first().type.empty()
|
| sdf-16 | error | StructureDefinition |
All element definitions must have unique ids (snapshot) Requirements: element ids need to be unique |
snapshot.element.all(id.exists()) and snapshot.element.id.trace('ids').isDistinct()
|
| sdf-17 | error | StructureDefinition |
All element definitions must have unique ids (diff) Requirements: element ids need to be unique |
differential.element.all(id.exists()) and differential.element.id.trace('ids').isDistinct()
|
| sdf-18 | error | StructureDefinition |
Context Invariants can only be used for extensions Requirements: contextInvariant |
contextInvariant.exists() implies type = 'Extension'
|
| sdf-8a | error | StructureDefinition.differential | In any differential, all the elements must start with the StructureDefinition's specified type for non-logical models, or with the same type name for logical models |
(%resource.kind = 'logical' or element.first().path.startsWith(%resource.type)) and (element.tail().empty() or element.tail().all(path.startsWith(%resource.differential.element.first().path.replaceMatches('\\..*','')&'.')))
|
| sdf-9 | error | StructureDefinition |
In any snapshot or differential, no label, code or requirements on an element without a "." in the path (e.g. the first element) Requirements: Because these 3 fields seem to be have overlapping meaning with the ones in the root of StructureDefinition |
children().element.where(path.contains('.').not()).label.empty() and children().element.where(path.contains('.').not()).code.empty() and children().element.where(path.contains('.').not()).requirements.empty()
|
| sdf-19 | error | StructureDefinition |
FHIR Specification models only use FHIR defined types Requirements: custom types only in logical models |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (differential.element.type.code.all(matches('^[a-zA-Z0-9]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')) and snapshot.element.type.code.all(matches('^[a-zA-Z0-9\\.]+$') or matches('^http:\\/\\/hl7\\.org\\/fhirpath\\/System\\.[A-Z][A-Za-z]+$')))
|
| sdf-20 | error | StructureDefinition.differential |
No slicing on the root element Requirements: no slicing on root |
element.where(path.contains('.').not()).slicing.empty()
|
| sdf-21 | error | StructureDefinition |
Default values can only be specified on specializations Requirements: no default values on data types or resources |
differential.element.defaultValue.exists() implies (derivation = 'specialization')
|
| sdf-22 | error | StructureDefinition |
FHIR Specification models never have default values Requirements: no default values on data types or resources |
url.startsWith('http://hl7.org/fhir/StructureDefinition') implies (snapshot.element.defaultValue.empty() and differential.element.defaultValue.empty())
|
| sdf-23 | error | StructureDefinition |
No slice name on root Requirements: no sliceName on root |
(snapshot | differential).element.all(path.contains('.').not() implies sliceName.empty())
|
| sdf-8b | error | StructureDefinition.snapshot | All snapshot elements must have a base definition |
element.all(base.exists())
|
This structure is derived from StructureDefinition
Summary
Mandatory: 3 elements(14 nested mandatory elements)
Must-Support: 9 elements
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of StructureDefinition.differential.element.code
Other representations of profile: CSV, Excel, Schematron