MedikationsListe (List)
Profil
Name | Canonical |
---|---|
ISiKMedikationsListe | https://gematik.de/fhir/isik/StructureDefinition/ISiKMedikationsListe |
ISiKMedikationsListe (List) | I | List | There are no (further) constraints on this element Element idList A list is a curated collection of resources Alternate namesCollection, WorkingList, Organizer DefinitionA list is a curated collection of resources.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idList.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idList.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idList.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idList.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idList.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idList.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | 0..* | Identifier | There are no (further) constraints on this element Element idList.identifier Business identifier DefinitionIdentifier for the List assigned for business purposes outside the context of FHIR.
| |
status | S Σ ?! | 1..1 | codeBinding | Element idList.status (Aktualitäts-)Status der Liste DefinitionIndicates the current state of this list. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. The current state of the list.
|
mode | S Σ ?! | 1..1 | codeBinding | Element idList.mode Listenmodus DefinitionHow this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. Lists are used in various ways, and it must be known in what way it is safe to use them. Beispiel: eingelesene Medikationspläne werden als snapshot repräsentiert. Kontinuierlich fortgeschriebene Listen, z.B. im Rahmen der hausinternen Behandlung, sind als 'working' codiert. The processing mode that applies to this list.
|
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.title Descriptive name for the list DefinitionA label for the list assigned by the author. Allows customization beyond just the code identifying the kind of list. Note that FHIR strings SHALL NOT exceed 1MB in size
General Dr. Jane's Patients Mappings
|
code | S Σ | 1..1 | CodeableConcept | Element idList.code Art der Liste. DefinitionThis code defines the purpose of the list - why it was created. Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included. Es ist mindestens ein Coding mit dem Code 'medications' anzugeben. Weitere Codes, z.B. im Kontext anderer Spezifikationen oder Hauscodierungen sind zulässig. What the purpose of a list is.
|
id | 0..1 | string | There are no (further) constraints on this element Element idList.code.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.code.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | S Σ | 1..* | Coding | Element idList.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
medications | S Σ | 1..1 | CodingPattern | Element idList.code.coding:medications Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
{ "system": "http://terminology.hl7.org/CodeSystem/list-example-use-codes", "code": "medications" }
|
id | 0..1 | string | There are no (further) constraints on this element Element idList.code.coding:medications.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.code.coding:medications.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | S Σ | 1..1 | uriPattern | There are no (further) constraints on this element Element idList.code.coding:medications.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
http://terminology.hl7.org/CodeSystem/list-example-use-codes
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.code.coding:medications.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 1..1 | codePattern | There are no (further) constraints on this element Element idList.code.coding:medications.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
medications
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element idList.code.coding:medications.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idList.code.coding:medications.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.code.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | S Σ I | 1..1 | Reference(Patient) | Element idList.subject Referenz auf den Patienten DefinitionThe common subject (or patient) of the resources that are in the list if there is one. The primary purpose of listing the subject explicitly is to help with finding the right list. Some purely arbitrary lists do not have a common subject, so this is optional.
|
id | 0..1 | string | There are no (further) constraints on this element Element idList.subject.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.subject.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idList.subject.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idList.subject.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idList.subject.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.subject.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
encounter | S I | 0..1 | Reference(Encounter) | Element idList.encounter Referenz auf den Abteilungskontakt DefinitionThe encounter that is the context in which this list was created. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
id | 0..1 | string | There are no (further) constraints on this element Element idList.encounter.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.encounter.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idList.encounter.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idList.encounter.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idList.encounter.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.encounter.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
date | S Σ | 0..1 | dateTime | Element idList.date Erstellungsdatum der Liste DefinitionThe date that the list was prepared. Identifies how current the list is which affects relevance. The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.
|
source | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | There are no (further) constraints on this element Element idList.source Who and/or what defined the list contents (aka Author) Alternate namesAuthor DefinitionThe entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. Allows follow-up as well as context. The primary source is the entity that made the decisions what items are in the list. This may be software or user. Reference(Practitioner | PractitionerRole | Patient | Device) Constraints
|
orderedBy | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idList.orderedBy What order the list has DefinitionWhat order applies to the items in the list. Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. What order applies to the items in a list.
| |
note | 0..* | Annotation | There are no (further) constraints on this element Element idList.note Comments about the list DefinitionComments that apply to the overall list. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
| |
entry | S I | 0..* | BackboneElement | Element idList.entry Listeneintrag DefinitionEntries in this list. If there are no entries in the list, an emptyReason SHOULD be provided.
|
id | 0..1 | string | There are no (further) constraints on this element Element idList.entry.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.entry.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idList.entry.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
flag | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idList.entry.flag Status/Workflow information about this item DefinitionThe flag allows the system constructing the list to indicate the role and significance of the item in the list. This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list. The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is "changes". Codes that provide further information about the reason and meaning of the item in the list.
| |
deleted | ?! I | 0..1 | boolean | There are no (further) constraints on this element Element idList.entry.deleted If this item is actually marked as deleted DefinitionTrue if this item is marked as deleted in the list. The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as "deleted". If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is "changes". A deleted entry should be displayed in narrative as deleted. This element is labeled as a modifier because it indicates that an item is (to be) no longer in the list. List items are generally only treated as deleted when this element explicitly carries a value of true. Systems SHOULD always populate this value when mode is 'changes'
|
date | S | 0..1 | dateTime | Element idList.entry.date Datum des Listeneintrags DefinitionWhen this item was added to the list. The date may be significant for understanding the meaning of items in a working list. nur zulässig im Listenmodus 'working'
|
item | S I | 1..1 | Reference(MedicationStatement) | Element idList.entry.item Referenz auf die MedikationsInformation DefinitionA reference to the actual resource from which data was derived. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(MedicationStatement) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idList.entry.item.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idList.entry.item.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idList.entry.item.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idList.entry.item.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idList.entry.item.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idList.entry.item.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
emptyReason | I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idList.emptyReason Why list is empty DefinitionIf the list is empty, why the list is empty. Allows capturing things like "none exist" or "not asked" which can be important for most lists. The various reasons for an empty list make a significant interpretation to its interpretation. Note that this code is for use when the entire list has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. If a list is empty, why it is empty.
|
Anmerkungen zu Must-Support-Feldern
Feldname | Kurzbeschreibung | Hinweise |
---|---|---|
List.status | (Aktualitäts-)Status der Liste | |
List.mode | Listenmodus | Beispiel: eingelesene Medikationspläne werden als snapshot repräsentiert. Kontinuierlich fortgeschriebene Listen, z.B. im Rahmen der hausinternen Behandlung, sind als 'working' codiert. |
List.code | Art der Liste. | Es ist mindestens ein Coding mit dem Code 'medications' anzugeben. Weitere Codes, z.B. im Kontext anderer Spezifikationen oder Hauscodierungen sind zulässig. |
List.subject | Referenz auf den Patienten | |
List.encounter | Referenz auf den Abteilungskontakt | |
List.date | Erstellungsdatum der Liste | |
List.entry | Listeneintrag | |
List.entry.date | Datum des Listeneintrags | nur zulässig im Listenmodus 'working' |
List.entry.item | Referenz auf die MedikationsInformation |
Beispiele
Valides Beispiel für das Profil MedikationsListe:
{ "resourceType": "List", "id": "ExampleISiKMedikationsListe", "meta": { "profile": [ "https://gematik.de/fhir/isik/StructureDefinition/ISiKMedikationsListe" ] }, "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/list-example-use-codes", "code": "medications" } ] }, "status": "current", "mode": "working", "subject": { "reference": "Patient/PatientinMusterfrau" }, "encounter": { "reference": "Encounter/Fachabteilungskontakt" }, "date": "2021-07-04", "entry": [ { "date": "2021-07-01", "item": { "reference": "MedicationStatement/ExampleISiKMedikationsInformation1" } }, { "date": "2021-07-04", "item": { "reference": "MedicationStatement/ExampleISiKMedikationsInformation2" } } ] }
Beispiel für eine Medikationsliste zur Behandlung von Morbus Parkinson (vgl. auch die vollständige Darstellung unter MedikationsInformation):
{ "resourceType": "List", "id": "ExampleISiKMedikationsListeParkinson", "meta": { "profile": [ "https://gematik.de/fhir/isik/StructureDefinition/ISiKMedikationsListe" ] }, "code": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/list-example-use-codes", "code": "medications" } ] }, "status": "current", "mode": "working", "subject": { "reference": "Patient/PatientinMusterfrau" }, "encounter": { "reference": "Encounter/Fachabteilungskontakt" }, "date": "2024-02-20", "entry": [ { "date": "2024-02-20", "item": { "reference": "MedicationStatement/ExampleISiKMedikationsInformationParkinson1" } }, { "date": "2024-02-20", "item": { "reference": "MedicationStatement/ExampleISiKMedikationsInformationParkinson2" } }, { "date": "2024-02-20", "item": { "reference": "MedicationStatement/ExampleISiKMedikationsInformationParkinson3" } }, { "date": "2024-02-20", "item": { "reference": "MedicationStatement/ExampleISiKMedikationsInformationParkinson4" } }, { "date": "2024-02-20", "item": { "reference": "MedicationStatement/ExampleISiKMedikationsInformationParkinson5" } } ] }
Interaktionen
Für die Ressource List MÜSSEN die REST-Interaktionen "READ", "CREATE" und "UPDATE" implementiert werden.
Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination:
Der Suchparameter "_id" MUSS unterstützt werden:
Beispiele:
GET [base]/List?_id=103270
Anwendungshinweise: Weitere Informationen zur Suche nach "_id" finden sich in der FHIR-Basisspezifikation - Abschnitt "Parameters for all resources".
Der Suchparameter "code" MUSS unterstützt werden:
Beispiele:
GET [base]/List?code=http://terminology.hl7.org/CodeSystem/list-example-use-codes|medications
Anwendungshinweise: Weitere Informationen zur Suche nach Token-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Der Suchparameter "date" MUSS unterstützt werden:
Beispiele:
GET [base]/List?date=2022-03-21
Anwendungshinweise: Weitere Informationen zur Suche nach Date-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Date".
Der Suchparameter "encounter" MUSS unterstützt werden:
Beispiele:
GET [base]/List?encounter=Encounter/123
Anwendungshinweise: Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Der verkettete Suchparameter "encounter.identifier" MUSS unterstützt werden:
Beispiele:
GET [base]/List?encounter.identifier=http://mein-krankenhaus.example/fhir/sid/fallnummern|7567867
GET [base]/List?encounter.identifier=7567867
Use Case Zusammenhang: Um bei einem wiederkehrenden Patienten eine
Command 'pagelink' could not render: Page not found.des Falls und damit eine falsche Medikation zu vermeiden.Anwendungshinweise: Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Weitere Informationen zur Suche nach verketteten Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Chained Parameters".
Der Suchparameter "item" MUSS unterstützt werden:
Beispiele:
GET [base]/List?item=MedicationStatement/131415
Anwendungshinweise: Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Der Suchparameter "patient" MUSS unterstützt werden:
Beispiele:
GET [base]/List?patient=Patient/123
Anwendungshinweise: Weitere Informationen zur Suche nach Reference-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Reference Search".
Der verkettete Suchparameter "patient.identifier" MUSS unterstützt werden:
Beispiele:
GET [base]/List?patient.identifier=http://mein-krankenhaus.example/fhir/sid/patienten|1032702
GET [base]/List?patient.identifier=1032702
Use Case Zusammenhang: Um bei der Medikationsliste eine
Command 'pagelink' could not render: Page not found.zwischen verschiedenen Patienten vermeiden.Anwendungshinweise: Weitere Informationen zur Suche nach Token-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".
Weitere Informationen zur Suche nach verketteten Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Chained Parameters".
Der Suchparameter "status" MUSS unterstützt werden:
Beispiele:
GET [base]/List?status=current
Anwendungshinweise: Weitere Informationen zur Suche nach Token-type Parametern finden sich in der FHIR-Basisspezifikation - Abschnitt "Token Search".