Global Core Electronic Medicinal Product Information (ePI), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/emedicinal-product-info/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/List-uv-epi | Version: 1.1.0 | ||||
| Standards status: Trial-use Active as of 2026-04-03 | Computable Name: ListUvEpi | ||||
List (ePI) - ported from Business Friendly ePI Outline
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | List | A list is a curated collection of resources Constraints: lst-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..1 | Narrative | This is a narrative description of the List and its content This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string | Authorisation Type URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-authorisation-type | |
![]() ![]() ![]() |
0..1 | Coding | Medicine Domain URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-medicine-domain | |
![]() ![]() ![]() |
0..1 | Identifier | Procedure Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-procedure-number | |
![]() ![]() ![]() |
0..1 | string | Version Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-version-number | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Jurisdiction URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-jurisdiction | |
![]() ![]() ![]() |
0..1 | Reference(Organization (ePI)) | Regulatory Agency URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-regulatory-agency | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..* | Identifier | Business identifier for this list | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 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. Required Pattern: working |
![]() ![]() |
Σ | 1..1 | string | This is a simple title for the List Example General: Dr. Jane's Patients |
![]() ![]() |
Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ePI List Type ValueSet (required) |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Representation defined by the system |
![]() ![]() |
Σ | 0..* | Reference(MedicinalProductDefinition (ePI)) | If all resources have the same subject |
![]() ![]() |
Σ | 1..1 | dateTime | When the list was prepared |
![]() ![]() |
Σ | 1..1 | Reference(Organization (ePI)) | Who and/or what defined the list contents (aka Author) |
![]() ![]() |
C | 1..* | BackboneElement | Entries in the list This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Language URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-entry-language |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: ePI List Entry Flag ValueSet (example) |
![]() ![]() ![]() |
?!S | 0..1 | boolean | If this item is actually marked as deleted |
![]() ![]() ![]() |
S | 1..1 | dateTime | When item added to list |
![]() ![]() ![]() |
1..1 | Reference(Bundle) | Actual entry | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Text alternative for the resource |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| List.status | Base | required | List Status | 📍5.0.0 | FHIR Std. |
| List.mode | Base | required | List Mode | 📍5.0.0 | FHIR Std. |
| List.code | Base | required | ePI List Type ValueSet | 📦1.1.0 | This IG |
| List.entry.flag | Base | example | ePI List Entry Flag ValueSet | 📦1.1.0 | This IG |
| List.entry.item.type | Base | extensible | Resource Types | 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | List | A list is a curated collection of resources | |
![]() ![]() |
1..1 | Narrative | This is a narrative description of the List and its content | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string | Authorisation Type URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-authorisation-type | |
![]() ![]() ![]() |
0..1 | Coding | Medicine Domain URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-medicine-domain | |
![]() ![]() ![]() |
0..1 | Identifier | Procedure Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-procedure-number | |
![]() ![]() ![]() |
0..1 | string | Version Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-version-number | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Jurisdiction URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-jurisdiction | |
![]() ![]() ![]() |
0..1 | Reference(Organization (ePI)) | Regulatory Agency URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-regulatory-agency | |
![]() ![]() |
1..* | Identifier | Business identifier for this list | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | current | retired | entered-in-error |
![]() ![]() |
1..1 | code | working | snapshot | changes Required Pattern: working | |
![]() ![]() |
1..1 | string | This is a simple title for the List | |
![]() ![]() |
1..1 | CodeableConcept | What the purpose of this list is Binding: ePI List Type ValueSet (required) | |
![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() |
0..* | Reference(MedicinalProductDefinition (ePI)) | If all resources have the same subject | |
![]() ![]() |
1..1 | dateTime | When the list was prepared | |
![]() ![]() |
1..1 | Reference(Organization (ePI)) | Who and/or what defined the list contents (aka Author) | |
![]() ![]() |
1..* | BackboneElement | Entries in the list | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Language URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-entry-language |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: ePI List Entry Flag ValueSet (example) |
![]() ![]() ![]() |
S | 0..1 | boolean | If this item is actually marked as deleted |
![]() ![]() ![]() |
S | 1..1 | dateTime | When item added to list |
![]() ![]() ![]() |
1..1 | Reference(Bundle) | Actual entry | |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.code | Base | required | ePI List Type ValueSet | 📦1.1.0 | This IG |
| List.entry.flag | Base | example | ePI List Entry Flag ValueSet | 📦1.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | List | A list is a curated collection of resources Constraints: lst-1 | ||||
![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
1..1 | Narrative | This is a narrative description of the List and its content This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | string | Authorisation Type URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-authorisation-type | |||||
![]() ![]() ![]() |
0..1 | Coding | Medicine Domain URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-medicine-domain | |||||
![]() ![]() ![]() |
0..1 | Identifier | Procedure Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-procedure-number | |||||
![]() ![]() ![]() |
0..1 | string | Version Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-version-number | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Jurisdiction URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-jurisdiction | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization (ePI)) | Regulatory Agency URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-regulatory-agency | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..* | Identifier | Business identifier for this list | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 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. Required Pattern: working | ||||
![]() ![]() |
Σ | 1..1 | string | This is a simple title for the List Example General: Dr. Jane's Patients | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ePI List Type ValueSet (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..* | Reference(MedicinalProductDefinition (ePI)) | If all resources have the same subject | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Context in which list created | |||||
![]() ![]() |
Σ | 1..1 | dateTime | When the list was prepared | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization (ePI)) | 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 | 1..* | BackboneElement | Entries in the list This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Language URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-entry-language | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: ePI List Entry Flag ValueSet (example) | ||||
![]() ![]() ![]() |
?!S | 0..1 | boolean | If this item is actually marked as deleted | ||||
![]() ![]() ![]() |
S | 1..1 | dateTime | When item added to list | ||||
![]() ![]() ![]() |
1..1 | Reference(Bundle) | Actual entry | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
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 | required | All Languages | 📍5.0.0 | FHIR Std. |
| List.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| List.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| List.status | Base | required | List Status | 📍5.0.0 | FHIR Std. |
| List.mode | Base | required | List Mode | 📍5.0.0 | FHIR Std. |
| List.code | Base | required | ePI List Type ValueSet | 📦1.1.0 | This IG |
| List.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| List.entry.flag | Base | example | ePI List Entry Flag ValueSet | 📦1.1.0 | This IG |
| List.entry.item.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| List.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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()
|
Summary
Mandatory: 14 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | List | A list is a curated collection of resources Constraints: lst-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..1 | Narrative | This is a narrative description of the List and its content This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string | Authorisation Type URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-authorisation-type | |
![]() ![]() ![]() |
0..1 | Coding | Medicine Domain URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-medicine-domain | |
![]() ![]() ![]() |
0..1 | Identifier | Procedure Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-procedure-number | |
![]() ![]() ![]() |
0..1 | string | Version Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-version-number | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Jurisdiction URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-jurisdiction | |
![]() ![]() ![]() |
0..1 | Reference(Organization (ePI)) | Regulatory Agency URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-regulatory-agency | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
1..* | Identifier | Business identifier for this list | |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 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. Required Pattern: working |
![]() ![]() |
Σ | 1..1 | string | This is a simple title for the List Example General: Dr. Jane's Patients |
![]() ![]() |
Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ePI List Type ValueSet (required) |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Representation defined by the system |
![]() ![]() |
Σ | 0..* | Reference(MedicinalProductDefinition (ePI)) | If all resources have the same subject |
![]() ![]() |
Σ | 1..1 | dateTime | When the list was prepared |
![]() ![]() |
Σ | 1..1 | Reference(Organization (ePI)) | Who and/or what defined the list contents (aka Author) |
![]() ![]() |
C | 1..* | BackboneElement | Entries in the list This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Language URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-entry-language |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: ePI List Entry Flag ValueSet (example) |
![]() ![]() ![]() |
?!S | 0..1 | boolean | If this item is actually marked as deleted |
![]() ![]() ![]() |
S | 1..1 | dateTime | When item added to list |
![]() ![]() ![]() |
1..1 | Reference(Bundle) | Actual entry | |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Text alternative for the resource |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| List.status | Base | required | List Status | 📍5.0.0 | FHIR Std. |
| List.mode | Base | required | List Mode | 📍5.0.0 | FHIR Std. |
| List.code | Base | required | ePI List Type ValueSet | 📦1.1.0 | This IG |
| List.entry.flag | Base | example | ePI List Entry Flag ValueSet | 📦1.1.0 | This IG |
| List.entry.item.type | Base | extensible | Resource Types | 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | List | A list is a curated collection of resources | |
![]() ![]() |
1..1 | Narrative | This is a narrative description of the List and its content | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
0..1 | string | Authorisation Type URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-authorisation-type | |
![]() ![]() ![]() |
0..1 | Coding | Medicine Domain URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-medicine-domain | |
![]() ![]() ![]() |
0..1 | Identifier | Procedure Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-procedure-number | |
![]() ![]() ![]() |
0..1 | string | Version Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-version-number | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Jurisdiction URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-jurisdiction | |
![]() ![]() ![]() |
0..1 | Reference(Organization (ePI)) | Regulatory Agency URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-regulatory-agency | |
![]() ![]() |
1..* | Identifier | Business identifier for this list | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | current | retired | entered-in-error |
![]() ![]() |
1..1 | code | working | snapshot | changes Required Pattern: working | |
![]() ![]() |
1..1 | string | This is a simple title for the List | |
![]() ![]() |
1..1 | CodeableConcept | What the purpose of this list is Binding: ePI List Type ValueSet (required) | |
![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system | |
![]() ![]() |
0..* | Reference(MedicinalProductDefinition (ePI)) | If all resources have the same subject | |
![]() ![]() |
1..1 | dateTime | When the list was prepared | |
![]() ![]() |
1..1 | Reference(Organization (ePI)) | Who and/or what defined the list contents (aka Author) | |
![]() ![]() |
1..* | BackboneElement | Entries in the list | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Language URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-entry-language |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: ePI List Entry Flag ValueSet (example) |
![]() ![]() ![]() |
S | 0..1 | boolean | If this item is actually marked as deleted |
![]() ![]() ![]() |
S | 1..1 | dateTime | When item added to list |
![]() ![]() ![]() |
1..1 | Reference(Bundle) | Actual entry | |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| List.code | Base | required | ePI List Type ValueSet | 📦1.1.0 | This IG |
| List.entry.flag | Base | example | ePI List Entry Flag ValueSet | 📦1.1.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | List | A list is a curated collection of resources Constraints: lst-1 | ||||
![]() ![]() |
Σ | 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: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
1..1 | Narrative | This is a narrative description of the List and its content This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | string | Authorisation Type URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-authorisation-type | |||||
![]() ![]() ![]() |
0..1 | Coding | Medicine Domain URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-medicine-domain | |||||
![]() ![]() ![]() |
0..1 | Identifier | Procedure Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-procedure-number | |||||
![]() ![]() ![]() |
0..1 | string | Version Number URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-version-number | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Jurisdiction URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-jurisdiction | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization (ePI)) | Regulatory Agency URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-regulatory-agency | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
1..* | Identifier | Business identifier for this list | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!SΣ | 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. Required Pattern: working | ||||
![]() ![]() |
Σ | 1..1 | string | This is a simple title for the List Example General: Dr. Jane's Patients | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | What the purpose of this list is Binding: ePI List Type ValueSet (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..* | Reference(MedicinalProductDefinition (ePI)) | If all resources have the same subject | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Context in which list created | |||||
![]() ![]() |
Σ | 1..1 | dateTime | When the list was prepared | ||||
![]() ![]() |
Σ | 1..1 | Reference(Organization (ePI)) | 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 | 1..* | BackboneElement | Entries in the list This repeating element order: Order has no meaning unless specifically asserted by List.orderedBy, in which case the List SHALL be interpreted as being ordered as specified by List.orderedBy. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Language URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ext-epi-entry-language | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: ePI List Entry Flag ValueSet (example) | ||||
![]() ![]() ![]() |
?!S | 0..1 | boolean | If this item is actually marked as deleted | ||||
![]() ![]() ![]() |
S | 1..1 | dateTime | When item added to list | ||||
![]() ![]() ![]() |
1..1 | Reference(Bundle) | Actual entry | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
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 | required | All Languages | 📍5.0.0 | FHIR Std. |
| List.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| List.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| List.status | Base | required | List Status | 📍5.0.0 | FHIR Std. |
| List.mode | Base | required | List Mode | 📍5.0.0 | FHIR Std. |
| List.code | Base | required | ePI List Type ValueSet | 📦1.1.0 | This IG |
| List.orderedBy | Base | preferred | List Order Codes | 📍5.0.0 | FHIR Std. |
| List.entry.flag | Base | example | ePI List Entry Flag ValueSet | 📦1.1.0 | This IG |
| List.entry.item.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| List.emptyReason | Base | preferred | List Empty Reasons | 📍5.0.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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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()
|
Summary
Mandatory: 14 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron