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

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

Resource Profile: Profile_R5_List_R3

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

This cross-version profile allows R5 List content to be represented via FHIR STU3 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 Information summarized from a list of other resources
Constraints: lst-2, lst-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.status Base required ListStatus 📍3.0.2 FHIR Std.
List.mode Base required ListMode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error List If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List Information summarized from a list of other resources
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: If all resources have the same subject(s) additional types
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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: 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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: source
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... item
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: 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 Information summarized from a list of other resources
Constraints: lst-2, 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
... 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: Example Use Codes for List (example): What the purpose of a list is
... subject Σ 0..1 Reference(Patient | Group | Device | Location) If all resources have the same subject
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: If all resources have the same subject(s) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Context in which list created
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 dateTime When the list was prepared
... source Σ 0..1 Reference(Practitioner | Patient | Device) Who and/or what defined the list contents (aka Author)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:source 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: source
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... orderedBy 0..1 CodeableConcept What order the list has
Binding: List Order Codes (preferred): What order applies to the items in a list
... note 0..* Annotation Comments about the list
... entry C 0..* BackboneElement Entries in the list
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: Patient Medicine Change Types (example): Codes that provide further information about the reason and meaning of the item in the list
.... deleted ?!C 0..1 boolean If this item is actually marked as deleted
.... date 0..1 dateTime When item added to list
.... item 1..1 Reference(Resource) Actual entry
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: item additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: List Empty Reasons (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 extensible Common Languages . 📍3.0.2 tx.fhir.org
List.status Base required ListStatus 📍3.0.2 FHIR Std.
List.mode Base required ListMode 📍3.0.2 FHIR Std.
List.code Base example Example Use Codes for List 📍3.0.2 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍3.0.2 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍1 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error List If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()

This structure is derived from List

Summary

Extensions

This structure refers to these extensions:

  • Unable to summarise extension http://hl7.org/fhir/StructureDefinition/alternate-reference (no extension found)

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List C 0..* List Information summarized from a list of other resources
Constraints: lst-2, lst-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
List.status Base required ListStatus 📍3.0.2 FHIR Std.
List.mode Base required ListMode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error List If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. List 0..* List Information summarized from a list of other resources
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: If all resources have the same subject(s) additional types
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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: 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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: source
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... item
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: 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 Information summarized from a list of other resources
Constraints: lst-2, 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
... 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: Example Use Codes for List (example): What the purpose of a list is
... subject Σ 0..1 Reference(Patient | Group | Device | Location) If all resources have the same subject
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: If all resources have the same subject(s) additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Context in which list created
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 dateTime When the list was prepared
... source Σ 0..1 Reference(Practitioner | Patient | Device) Who and/or what defined the list contents (aka Author)
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:source 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: source
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... orderedBy 0..1 CodeableConcept What order the list has
Binding: List Order Codes (preferred): What order applies to the items in a list
... note 0..* Annotation Comments about the list
... entry C 0..* BackboneElement Entries in the list
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: Patient Medicine Change Types (example): Codes that provide further information about the reason and meaning of the item in the list
.... deleted ?!C 0..1 boolean If this item is actually marked as deleted
.... date 0..1 dateTime When item added to list
.... item 1..1 Reference(Resource) Actual entry
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: item additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: List Empty Reasons (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 extensible Common Languages . 📍3.0.2 tx.fhir.org
List.status Base required ListStatus 📍3.0.2 FHIR Std.
List.mode Base required ListMode 📍3.0.2 FHIR Std.
List.code Base example Example Use Codes for List 📍3.0.2 FHIR Std.
List.orderedBy Base preferred List Order Codes 📍3.0.2 FHIR Std.
List.entry.flag Base example Patient Medicine Change Types 📍1 FHIR Std.
List.emptyReason Base preferred List Empty Reasons 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error List If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
lst-1 error List A list can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
lst-2 error List The deleted flag can only be used if the mode of the list is "changes" mode = 'changes' or entry.deleted.empty()

This structure is derived from List

Summary

Extensions

This structure refers to these extensions:

  • Unable to summarise extension http://hl7.org/fhir/StructureDefinition/alternate-reference (no extension found)

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron