Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_List_R5

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-List Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_List_R5

This cross-version profile allows STU3 List content to be represented via FHIR R5 List resources.

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 of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List(5.0.0) 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

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.

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

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List(5.0.0) A list is a curated collection of resources
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) STU3: If all resources have the same subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 Reference(Resource) STU3: encounter 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) STU3: source
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.note
... entry
.... item
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 0..1 Reference(Resource) STU3: item additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List(5.0.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 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.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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(s)
.... id 0..1 id 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) STU3: If all resources have the same subject
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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Context in which list created
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:encounter 0..1 Reference(Resource) STU3: encounter 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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)
.... id 0..1 id 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) STU3: 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... 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
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 ?! 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:item 0..1 Reference(Resource) STU3: item 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
... 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.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
List.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
List.language Base required All Languages 📍5.0.0 FHIR Std.
List.text.status Base required NarrativeStatus 📍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 example Example Use Codes for List 📍5.0.0 FHIR Std.
List.subject.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
List.encounter.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
List.source.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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.entry.item.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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 List.meta, List.meta.extension, List.meta.extension:meta, List.meta.versionId, List.meta.lastUpdated, List.meta.source, List.meta.profile, List.meta.security, List.meta.tag, List.implicitRules, List.language, List.text, List.text.extension, List.text.extension:text, List.text.status, List.text.div, List.extension, List.modifierExtension, List.identifier, List.identifier.extension, List.identifier.extension:identifier, List.identifier.use, List.identifier.type, List.identifier.system, List.identifier.value, List.identifier.period, List.identifier.assigner, 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.encounter.extension, List.encounter.extension:encounter, List.encounter.reference, List.encounter.type, List.encounter.identifier, List.encounter.display, 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.note.extension, List.note.extension:note, List.note.author[x], List.note.time, List.note.text, List.entry, List.entry.extension, List.entry.modifierExtension, List.entry.flag, List.entry.deleted, List.entry.date, List.entry.item, List.entry.item.extension, List.entry.item.extension:item, List.entry.item.reference, List.entry.item.type, List.entry.item.identifier, List.entry.item.display, List.emptyReason All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error List.meta.extension, List.meta.extension:meta, List.text.extension, List.text.extension:text, List.extension, List.modifierExtension, List.identifier.extension, List.identifier.extension:identifier, List.subject.extension, List.subject.extension:subject, List.encounter.extension, List.encounter.extension:encounter, List.source.extension, List.source.extension:source, List.note.extension, List.note.extension:note, List.entry.extension, List.entry.modifierExtension, List.entry.item.extension, List.entry.item.extension:item 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()
txt-1 error List.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error List.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List(5.0.0) 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
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

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.

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

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List(5.0.0) A list is a curated collection of resources
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) STU3: If all resources have the same subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 Reference(Resource) STU3: encounter 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) STU3: source
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.note
... entry
.... item
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 0..1 Reference(Resource) STU3: item additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List(5.0.0) 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 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.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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(s)
.... id 0..1 id 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) STU3: If all resources have the same subject
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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Context in which list created
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:encounter 0..1 Reference(Resource) STU3: encounter 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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)
.... id 0..1 id 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) STU3: 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-List.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... 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
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 ?! 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:item 0..1 Reference(Resource) STU3: item 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") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
... 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.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
List.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
List.language Base required All Languages 📍5.0.0 FHIR Std.
List.text.status Base required NarrativeStatus 📍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 example Example Use Codes for List 📍5.0.0 FHIR Std.
List.subject.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
List.encounter.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
List.source.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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.entry.item.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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 List.meta, List.meta.extension, List.meta.extension:meta, List.meta.versionId, List.meta.lastUpdated, List.meta.source, List.meta.profile, List.meta.security, List.meta.tag, List.implicitRules, List.language, List.text, List.text.extension, List.text.extension:text, List.text.status, List.text.div, List.extension, List.modifierExtension, List.identifier, List.identifier.extension, List.identifier.extension:identifier, List.identifier.use, List.identifier.type, List.identifier.system, List.identifier.value, List.identifier.period, List.identifier.assigner, 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.encounter.extension, List.encounter.extension:encounter, List.encounter.reference, List.encounter.type, List.encounter.identifier, List.encounter.display, 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.note.extension, List.note.extension:note, List.note.author[x], List.note.time, List.note.text, List.entry, List.entry.extension, List.entry.modifierExtension, List.entry.flag, List.entry.deleted, List.entry.date, List.entry.item, List.entry.item.extension, List.entry.item.extension:item, List.entry.item.reference, List.entry.item.type, List.entry.item.identifier, List.entry.item.display, List.emptyReason All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error List.meta.extension, List.meta.extension:meta, List.text.extension, List.text.extension:text, List.extension, List.modifierExtension, List.identifier.extension, List.identifier.extension:identifier, List.subject.extension, List.subject.extension:subject, List.encounter.extension, List.encounter.extension:encounter, List.source.extension, List.source.extension:source, List.note.extension, List.note.extension:note, List.entry.extension, List.entry.modifierExtension, List.entry.item.extension, List.entry.item.extension:item 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()
txt-1 error List.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error List.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron