Medikationsplan 4 PLUS - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: MedicationStatement List MP4+
| Official URL: https://www.charite.de/fhir/medikationsplan/StructureDefinition/List | Version: 0.1.0 | |||
| Draft as of 2022-11-28 | Computable Name: ListMP4P | |||
Die Composition definiert die Struktur des Medikationsplans.
Usage:
- Refer to this Resource Profile:
- Examples for this Resource Profile: List/ExampleList
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List | 0..* | List | A list is a curated collection of resources | |
  id | S | 0..1 | id | Logical id of this artifact |
 meta | S | 0..1 | Meta | Metadata about the resource |
  profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| language | S | 0..1 | code | Language of the resource content |
| identifier | 0..0 | |||
| status | S | 1..1 | code | current | retired | entered-in-error Fixed Value: current |
| mode | S | 1..1 | code | working | snapshot | changes Fixed Value: snapshot |
| title | 0..1 | string | Zwischenüberschrift Titel (@c) | |
| code | S | 0..1 | CodeableConcept | What the purpose of this list is Binding: KBV_BMP_Zwischenueberschrift_VS (required) |
| coding | S | 1..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system |
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| text | S | 0..1 | string | Plain text representation of the concept |
| subject | 0..0 | |||
| encounter | 0..0 | |||
| date | 0..0 | |||
| source | 0..0 | |||
| orderedBy | 0..0 | |||
| note | 0..0 | |||
| entry | S | 0..* | BackboneElement | Entries in the list |
| flag | 0..0 | |||
| deleted | 0..0 | |||
| date | 0..0 | |||
  item | S | 1..1 | Reference(MedicationStatement MP4+ | Freitext MP4+) | Actual entry |
 reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| emptyReason | 0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| List.code | required | KBV_BMP_Zwischenueberschrift_VS (a valid code from KBV_BMP_Zwischenueberschrift_CS) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources | ||||
 id | SΣ | 0..1 | id | Logical id of this artifact | ||||
 meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | S | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status | ?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Fixed Value: current | ||||
| mode | ?!SΣ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Fixed Value: snapshot | ||||
| title | Σ | 0..1 | string | Zwischenüberschrift Titel (@c) Example General: Dr. Jane's Patients | ||||
| code | SΣ | 0..1 | CodeableConcept | What the purpose of this list is Binding: KBV_BMP_Zwischenueberschrift_VS (required) | ||||
| coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
| system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| entry | SC | 0..* | BackboneElement | Entries in the list | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| item | S | 1..1 | Reference(MedicationStatement MP4+ | Freitext MP4+) | Actual entry | ||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | ||||
| List.language | preferred | CommonLanguages
| ||||
| List.status | required | Fixed Value: current | ||||
| List.mode | required | Fixed Value: snapshot | ||||
| List.code | required | KBV_BMP_Zwischenueberschrift_VS (a valid code from KBV_BMP_Zwischenueberschrift_CS) |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() | |
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources | ||||
| id | SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (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 | ||||
| language | S | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status | ?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Fixed Value: current | ||||
| mode | ?!SΣ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Fixed Value: snapshot | ||||
| title | Σ | 0..1 | string | Zwischenüberschrift Titel (@c) Example General: Dr. Jane's Patients | ||||
| code | SΣ | 0..1 | CodeableConcept | What the purpose of this list is Binding: KBV_BMP_Zwischenueberschrift_VS (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| entry | SC | 0..* | BackboneElement | Entries in the list | ||||
| 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 | ||||
| item | S | 1..1 | Reference(MedicationStatement MP4+ | Freitext MP4+) | Actual entry | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | ||||
| List.meta.security | extensible | All Security Labels | ||||
| List.meta.tag | example | CommonTags | ||||
| List.language | preferred | CommonLanguages
| ||||
| List.status | required | Fixed Value: current | ||||
| List.mode | required | Fixed Value: snapshot | ||||
| List.code | required | KBV_BMP_Zwischenueberschrift_VS (a valid code from KBV_BMP_Zwischenueberschrift_CS) | ||||
| List.entry.item.type | extensible | ResourceType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from List
Differential View
This structure is derived from List
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | 0..* | List | A list is a curated collection of resources | |
| id | S | 0..1 | id | Logical id of this artifact |
| meta | S | 0..1 | Meta | Metadata about the resource |
| profile | S | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| language | S | 0..1 | code | Language of the resource content |
| identifier | 0..0 | |||
| status | S | 1..1 | code | current | retired | entered-in-error Fixed Value: current |
| mode | S | 1..1 | code | working | snapshot | changes Fixed Value: snapshot |
| title | 0..1 | string | Zwischenüberschrift Titel (@c) | |
| code | S | 0..1 | CodeableConcept | What the purpose of this list is Binding: KBV_BMP_Zwischenueberschrift_VS (required) |
| coding | S | 1..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system |
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| text | S | 0..1 | string | Plain text representation of the concept |
| subject | 0..0 | |||
| encounter | 0..0 | |||
| date | 0..0 | |||
| source | 0..0 | |||
| orderedBy | 0..0 | |||
| note | 0..0 | |||
| entry | S | 0..* | BackboneElement | Entries in the list |
| flag | 0..0 | |||
| deleted | 0..0 | |||
| date | 0..0 | |||
| item | S | 1..1 | Reference(MedicationStatement MP4+ | Freitext MP4+) | Actual entry |
| reference | S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| emptyReason | 0..0 | |||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| List.code | required | KBV_BMP_Zwischenueberschrift_VS (a valid code from KBV_BMP_Zwischenueberschrift_CS) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources | ||||
| id | SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| profile | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | S | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status | ?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Fixed Value: current | ||||
| mode | ?!SΣ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Fixed Value: snapshot | ||||
| title | Σ | 0..1 | string | Zwischenüberschrift Titel (@c) Example General: Dr. Jane's Patients | ||||
| code | SΣ | 0..1 | CodeableConcept | What the purpose of this list is Binding: KBV_BMP_Zwischenueberschrift_VS (required) | ||||
| coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
| system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| entry | SC | 0..* | BackboneElement | Entries in the list | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| item | S | 1..1 | Reference(MedicationStatement MP4+ | Freitext MP4+) | Actual entry | ||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | ||||
| List.language | preferred | CommonLanguages
| ||||
| List.status | required | Fixed Value: current | ||||
| List.mode | required | Fixed Value: snapshot | ||||
| List.code | required | KBV_BMP_Zwischenueberschrift_VS (a valid code from KBV_BMP_Zwischenueberschrift_CS) |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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() | |
| lst-2 | error | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | error | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List | C | 0..* | List | A list is a curated collection of resources | ||||
| id | SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta | SΣ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | SΣ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (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 | ||||
| language | S | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| status | ?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Fixed Value: current | ||||
| mode | ?!SΣ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. Fixed Value: snapshot | ||||
| title | Σ | 0..1 | string | Zwischenüberschrift Titel (@c) Example General: Dr. Jane's Patients | ||||
| code | SΣ | 0..1 | CodeableConcept | What the purpose of this list is Binding: KBV_BMP_Zwischenueberschrift_VS (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| entry | SC | 0..* | BackboneElement | Entries in the list | ||||
| 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 | ||||
| item | S | 1..1 | Reference(MedicationStatement MP4+ | Freitext MP4+) | Actual entry | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet / Code | ||||
| List.meta.security | extensible | All Security Labels | ||||
| List.meta.tag | example | CommonTags | ||||
| List.language | preferred | CommonLanguages
| ||||
| List.status | required | Fixed Value: current | ||||
| List.mode | required | Fixed Value: snapshot | ||||
| List.code | required | KBV_BMP_Zwischenueberschrift_VS (a valid code from KBV_BMP_Zwischenueberschrift_CS) | ||||
| List.entry.item.type | extensible | ResourceType |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
This structure is derived from List
Other representations of profile: CSV, Excel, Schematron