Extensions for Using Data Elements from FHIR R4 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-List | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R4_List_R4B | ||
This cross-version profile allows R4 List content to be represented via FHIR R4B 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | List(4.3.0) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
![]() ![]() |
?!Σ | 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.3.0 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.3.0 | 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.exists() and ('#'+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(uri) = '#').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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | List(4.3.0) | A list is a curated collection of resources | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | List(4.3.0) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
![]() ![]() |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
![]() ![]() |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Context in which list created | |||||
![]() ![]() |
Σ | 0..1 | dateTime | When the list was prepared | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
![]() ![]() |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
![]() ![]() |
0..* | Annotation | Comments about the list | |||||
![]() ![]() |
C | 0..* | BackboneElement | Entries in the list | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
![]() ![]() ![]() |
0..1 | dateTime | When item added to list | |||||
![]() ![]() ![]() |
1..1 | Reference(Resource) | Actual entry | |||||
![]() ![]() |
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.3.0 | FHIR Std. |
| List.status | Base | required | ListStatus | 📍4.3.0 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.3.0 | FHIR Std. |
| List.code | Base | example | Example Use Codes for List | 📍4.3.0 | FHIR Std. |
| List.orderedBy | Base | preferred | List Order Codes | 📍4.3.0 | FHIR Std. |
| List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.3.0 | FHIR Std. |
| List.emptyReason | Base | preferred | List Empty Reasons | 📍4.3.0 | 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | List.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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.encounter, List.date, List.source, 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.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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | List(4.3.0) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
![]() ![]() |
?!Σ | 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.3.0 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.3.0 | 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.exists() and ('#'+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(uri) = '#').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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | List(4.3.0) | A list is a curated collection of resources | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | List(4.3.0) | A list is a curated collection of resources Constraints: lst-1, lst-2, lst-3 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() |
?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. | ||||
![]() ![]() |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
![]() ![]() |
Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Context in which list created | |||||
![]() ![]() |
Σ | 0..1 | dateTime | When the list was prepared | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
![]() ![]() |
0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
![]() ![]() |
0..* | Annotation | Comments about the list | |||||
![]() ![]() |
C | 0..* | BackboneElement | Entries in the list | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
![]() ![]() ![]() |
0..1 | dateTime | When item added to list | |||||
![]() ![]() ![]() |
1..1 | Reference(Resource) | Actual entry | |||||
![]() ![]() |
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.3.0 | FHIR Std. |
| List.status | Base | required | ListStatus | 📍4.3.0 | FHIR Std. |
| List.mode | Base | required | ListMode | 📍4.3.0 | FHIR Std. |
| List.code | Base | example | Example Use Codes for List | 📍4.3.0 | FHIR Std. |
| List.orderedBy | Base | preferred | List Order Codes | 📍4.3.0 | FHIR Std. |
| List.entry.flag | Base | example | Patient Medicine Change Types | 📍4.3.0 | FHIR Std. |
| List.emptyReason | Base | preferred | List Empty Reasons | 📍4.3.0 | 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | List.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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.encounter, List.date, List.source, 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.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