Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-List | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_List_R4 | ||
This cross-version profile allows R5 List content to be represented via FHIR R4 List resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  List |
C | 0..* | List(4.0.1) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
 mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | List | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | List.implicitRules, List.modifierExtension, List.status, List.mode | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | List.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| lst-1 | error | List | A list can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" |
mode = 'changes' or entry.deleted.empty()
|
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" |
mode = 'working' or entry.date.empty()
|
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| List |
0..* | List(4.0.1) | A list is a curated collection of resources | |
  subject |
||||
   Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:subject |
0..* | Reference(Resource) | R5: If all resources have the same subject(s) additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| source |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:source |
0..1 | Reference(Resource) | R5: source URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | List(4.0.1) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
 subject |
Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | R5: If all resources have the same subject(s) additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
0..1 | Reference(Encounter) | Context in which list created | |||||
| date |
Σ | 0..1 | dateTime | When the list was prepared | ||||
| source |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:source |
0..1 | Reference(Resource) | R5: source URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| orderedBy |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note |
0..* | Annotation | Comments about the list | |||||
| entry |
C | 0..* | BackboneElement | Entries in the list | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
1..1 | Reference(Resource) | Actual entry | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std. |
| List.code | Base | example | Example Use Codes for List | 📍4.0.1 | FHIR Std. |
| List.subject.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| List.source.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| List.orderedBy | Base | preferred | List Order Codes | 📍4.0.1 | FHIR Std. |
| List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std. |
| List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | List | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | List.meta, List.implicitRules, List.language, List.text, List.extension, List.modifierExtension, List.identifier, List.status, List.mode, List.title, List.code, List.subject, List.subject.extension, List.subject.extension:subject, List.subject.reference, List.subject.type, List.subject.identifier, List.subject.display, List.encounter, List.date, List.source, List.source.extension, List.source.extension:source, List.source.reference, List.source.type, List.source.identifier, List.source.display, List.orderedBy, List.note, List.entry, List.entry.extension, List.entry.modifierExtension, List.entry.flag, List.entry.deleted, List.entry.date, List.entry.item, List.emptyReason | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | List.extension, List.modifierExtension, List.subject.extension, List.subject.extension:subject, List.source.extension, List.source.extension:source, List.entry.extension, List.entry.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| lst-1 | error | List | A list can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" |
mode = 'changes' or entry.deleted.empty()
|
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" |
mode = 'working' or entry.date.empty()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| List |
C | 0..* | List(4.0.1) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | List | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | List.implicitRules, List.modifierExtension, List.status, List.mode | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | List.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| lst-1 | error | List | A list can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" |
mode = 'changes' or entry.deleted.empty()
|
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" |
mode = 'working' or entry.date.empty()
|
Differential View
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| List |
0..* | List(4.0.1) | A list is a curated collection of resources | |
| subject |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject |
0..* | Reference(Resource) | R5: If all resources have the same subject(s) additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| source |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:source |
0..1 | Reference(Resource) | R5: source URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | List(4.0.1) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
0..* | Identifier | Business identifier | |||||
| status |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
| subject |
Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | R5: If all resources have the same subject(s) additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
0..1 | Reference(Encounter) | Context in which list created | |||||
| date |
Σ | 0..1 | dateTime | When the list was prepared | ||||
| source |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:source |
0..1 | Reference(Resource) | R5: source URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| orderedBy |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note |
0..* | Annotation | Comments about the list | |||||
| entry |
C | 0..* | BackboneElement | Entries in the list | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
1..1 | Reference(Resource) | Actual entry | |||||
| emptyReason |
C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| List.status | Base | required | ListStatus | 📍4.0.1 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.0.1 | FHIR Std. |
| List.code | Base | example | Example Use Codes for List | 📍4.0.1 | FHIR Std. |
| List.subject.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| List.source.type | Base | extensible |
ResourceType
|
📍4.0.1 | tx.fhir.org |
| List.orderedBy | Base | preferred | List Order Codes | 📍4.0.1 | FHIR Std. |
| List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.0.1 | FHIR Std. |
| List.emptyReason | Base | preferred | List Empty Reasons | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | List | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | List.meta, List.implicitRules, List.language, List.text, List.extension, List.modifierExtension, List.identifier, List.status, List.mode, List.title, List.code, List.subject, List.subject.extension, List.subject.extension:subject, List.subject.reference, List.subject.type, List.subject.identifier, List.subject.display, List.encounter, List.date, List.source, List.source.extension, List.source.extension:source, List.source.reference, List.source.type, List.source.identifier, List.source.display, List.orderedBy, List.note, List.entry, List.entry.extension, List.entry.modifierExtension, List.entry.flag, List.entry.deleted, List.entry.date, List.entry.item, List.emptyReason | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | List.extension, List.modifierExtension, List.subject.extension, List.subject.extension:subject, List.source.extension, List.source.extension:source, List.entry.extension, List.entry.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| lst-1 | error | List | A list can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" |
mode = 'changes' or entry.deleted.empty()
|
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" |
mode = 'working' or entry.date.empty()
|
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change