Global Core Electronic Medicinal Product Information (ePI)
1.1.0 - trial-use International flag

Global Core Electronic Medicinal Product Information (ePI), published by HL7 International - Biomedical Research & Regulation Work Group. 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

Resource Profile: List (ePI)

Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/List-uv-epi Version: 1.1.0
Computable Name: ListUvEpi

List (ePI) - ported from Business Friendly ePI Outline

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... identifier 0..* Identifier Business identifier for this list
... 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..* Reference(Resource) If all resources have the same subject
... 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 | Organization | RelatedPerson | CareTeam) Who and/or what defined the list contents (aka Author)
... note 0..* Annotation Comments about the list
... entry C 0..* 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.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 ?! 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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 example Example Use Codes for List 📍5.0.0 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍5.0.0 FHIR Std.

Constraints

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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List A list is a curated collection of resources
... text 0..1 Narrative Text summary of the resource, for human interpretation
... identifier 0..* Identifier Business identifier for this list
... status 1..1 code current | retired | entered-in-error
... title 0..1 string Descriptive name for the list
... code 0..1 CodeableConcept What the purpose of this list is
... subject 0..* Reference(Resource) If all resources have the same subject
... 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 | Organization | RelatedPerson | CareTeam) Who and/or what defined the list contents (aka Author)
... note 0..* Annotation Comments about the list
... entry 0..* BackboneElement Entries in the list
.... flag 0..1 CodeableConcept Status/Workflow information about this item
.... deleted 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1
... 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
... 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
... identifier 0..* Identifier Business identifier for this list
... 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..* Reference(Resource) If all resources have the same subject
... 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 | Organization | RelatedPerson | CareTeam) Who and/or what defined the list contents (aka Author)
... 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
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.
.... 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
.... 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 ?! 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.language Base required All Languages 📍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 example Example Use Codes for List 📍5.0.0 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍5.0.0 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍5.0.0 FHIR Std.

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... identifier 0..* Identifier Business identifier for this list
... 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..* Reference(Resource) If all resources have the same subject
... 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 | Organization | RelatedPerson | CareTeam) Who and/or what defined the list contents (aka Author)
... note 0..* Annotation Comments about the list
... entry C 0..* 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.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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 ?! 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
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 example Example Use Codes for List 📍5.0.0 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍5.0.0 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List A list is a curated collection of resources
... text 0..1 Narrative Text summary of the resource, for human interpretation
... identifier 0..* Identifier Business identifier for this list
... status 1..1 code current | retired | entered-in-error
... title 0..1 string Descriptive name for the list
... code 0..1 CodeableConcept What the purpose of this list is
... subject 0..* Reference(Resource) If all resources have the same subject
... 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 | Organization | RelatedPerson | CareTeam) Who and/or what defined the list contents (aka Author)
... note 0..* Annotation Comments about the list
... entry 0..* BackboneElement Entries in the list
.... flag 0..1 CodeableConcept Status/Workflow information about this item
.... deleted 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

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List A list is a curated collection of resources
Constraints: lst-1
... 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
... 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
... identifier 0..* Identifier Business identifier for this list
... 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..* Reference(Resource) If all resources have the same subject
... 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 | Organization | RelatedPerson | CareTeam) Who and/or what defined the list contents (aka Author)
... 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
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.
.... 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
.... 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 ?! 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.language Base required All Languages 📍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 example Example Use Codes for List 📍5.0.0 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍5.0.0 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍5.0.0 FHIR Std.

Constraints

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

 

Other representations of profile: CSV, Excel, Schematron