EPAPlanAllergyIntoleranceList

Das EPAPlanAllergyIntoleranceList-Profil bildet eine Liste von Allergien und/oder Unverträglichkeiten eines/einer Patient:in ab. Diese enthält alle Allergie/Unverträglichkeit-Einträge eines/einer Patient:in. In der Liste werden ein oder mehrere Profilelemente EPAAllergyIntolerance referenziert.

NameStatusVersionCanonicalBasis
EPAPlanAllergyIntoleranceListactive1.1.1https://gematik.de/fhir/epa-medication/StructureDefinition/epa-plan-allergy-intolerance-listhttp://hl7.org/fhir/StructureDefinition/List

Profil für gemeinsame Datengrundlage im ePA Medication Service

EPA Plan AllergyIntolerance List

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdS Σ0..1id
lastUpdatedS Σ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
status1..1codeBindingFixed Value
divI1..1xhtml
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifier0..*Identifier
statusS Σ ?!1..1codeBindingPattern
modeS Σ ?!1..1codeBindingPattern
titleΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierS Σ1..1IdentifierKvid10
displayΣ0..1string
encounterI0..1Reference(Encounter)
dateΣ0..1dateTime
sourceΣ I0..1Reference(Practitioner | PractitionerRole | Patient | Device)
orderedBy0..1CodeableConceptBinding
note0..*Annotation
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
flag0..1CodeableConcept
deleted?! I0..1boolean
date0..1dateTime
itemS I1..1Reference(EPAAllergyIntolerance)
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
List
DefinitionDieses Profil bildet die Liste von Allergien/Unverträglichkeiten ab. Diese enthält alle Allergie/Unverträglichkeit-Einträge eines/einer Patient:in.
Cardinality0...*
AliasCollection, WorkingList, Organizer
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: 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-3: 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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • lst-3: An entry date can only be used if the mode of the list is "working"
    mode = 'working' or entry.date.empty()
  • lst-2: The deleted flag can only be used if the mode of the list is "changes"
    mode = 'changes' or entry.deleted.empty()
  • lst-1: A list can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: Entity. Role, or Act
  • rim: Act[classCode<ORG,moodCode=EVN]
List.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

List.meta
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.
Cardinality0...1
TypeMeta
Must SupportTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
List.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.meta.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
Must SupportTrue
SummaryTrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
List.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
Must SupportTrue
SummaryTrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
List.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality0...1
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
List.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality0...*
Typecanonical(StructureDefinition)
SummaryTrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
List.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...*
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
List.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...*
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
List.implicitRules
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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
List.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
List.text
DefinitionIn diesem Element können die, in der Instanz, enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
List.text.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.text.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.text.status
DefinitionThe status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Cardinality1...1
Typecode
Binding

The status of a resource narrative.

NarrativeStatus (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

extensions

Mappings
  • rim: n/a
  • rim: N/A
List.text.div
DefinitionThe actual narrative content, a stripped down version of XHTML.
Cardinality1...1
Typexhtml
Comments

The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
    htmlChecks()
  • txt-2: The narrative SHALL have some non-whitespace content
    htmlChecks()
Mappings
  • rim: n/a
  • rim: N/A
List.contained
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.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

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.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
List.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

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.

Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.identifier
DefinitionIdentifier for the List assigned for business purposes outside the context of FHIR.
Cardinality0...*
TypeIdentifier
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • rim: .id
List.status
DefinitionHier wird der Status einer Liste von Allergien/Unverträglichkeiten abgebildet. Der Status der Liste ist im MIO Medikation auf "current/aktuell" festgesetzt.
Cardinality1...1
Typecode
Binding

The current state of the list.

ListStatus (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

current

Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: .status[current=active;retired=obsolete;entered-in-error=nullified]
List.mode
DefinitionHier wird der Modus der Verarbeitung einer Liste von Allergien/Unverträglichkeiten abgebildet. Im Rahmen der Erstellung einer solchen Liste innerhalb des MIO Medikation ist der Modus auf "Snapshot/Momentaufnahme der Liste" festgesetzt
Cardinality1...1
Typecode
Binding

The processing mode that applies to this list.

ListMode (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Requirements

Lists are used in various ways, and it must be known in what way it is safe to use them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

snapshot

Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
List.title
DefinitionA label for the list assigned by the author.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Allows customization beyond just the code identifying the kind of list.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

Dr. Jane's Patients


Mappings
  • rim: n/a
  • rim: .title
List.code
DefinitionHier wird ein Code für die Art der Liste angegeben. Die Art der Liste im MIO Medikation ist auf "allergies/ Allergien/Unverträglichkeiten" festgesetzt.
Cardinality1...1
TypeCodeableConcept
Binding

What the purpose of a list is.

ExampleUseCodesForList (example)
Must SupportTrue
SummaryTrue
Requirements

Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.

Comments

If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.what[x]
  • rim: .code
List.code.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.code.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.code.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
BindingEPAPlanAllergyIntoleranceListCodeVS (required)
Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
List.code.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.code.coding.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.code.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
List.code.coding.version
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.
Cardinality0...1
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
List.code.coding.code
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).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
List.code.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
List.code.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

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.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
List.code.text
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.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
List.subject
DefinitionThe common subject (or patient) of the resources that are in the list if there is one.
Cardinality1...1
TypeReference(Patient)
Must SupportTrue
SummaryTrue
Requirements

The primary purpose of listing the subject explicitly is to help with finding the right list.

Comments

Some purely arbitrary lists do not have a common subject, so this is optional.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • rim: .participation[typeCode<SUB].role (and sometimes .player)
  • w5: FiveWs.subject
List.subject.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.subject.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.subject.reference
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.
Cardinality0...1
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
List.subject.type
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).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
List.subject.identifier
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality1...1
TypeIdentifierKvid10
Must SupportTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
List.subject.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
List.encounter
DefinitionThe encounter that is the context in which this list was created.
Cardinality0...1
TypeReference(Encounter)
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.context
  • rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
List.date
DefinitionThe date that the list was prepared.
Cardinality0...1
TypedateTime
SummaryTrue
Requirements

Identifies how current the list is which affects relevance.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.recorded
  • rim: .participation[typeCode<AUT].time[type=TS]
List.source
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.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole | Patient | Device)
SummaryTrue
AliasAuthor
Requirements

Allows follow-up as well as context.

Comments

The primary source is the entity that made the decisions what items are in the list. This may be software or user.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST] or .participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]
List.orderedBy
DefinitionWhat order applies to the items in the list.
Cardinality0...1
TypeCodeableConcept
Binding

What order applies to the items in a list.

ListOrderCodes (preferred)
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
List.note
DefinitionComments that apply to the overall list.
Cardinality0...*
TypeAnnotation
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act
  • rim: .inboundRelationship[typeCode=SUBJ].act.text
List.entry
DefinitionHier können Einträge für Allergien oder Unverträglichkeiten referenziert werden.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
List.entry.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.entry.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.entry.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.entry.flag
DefinitionThe flag allows the system constructing the list to indicate the role and significance of the item in the list.
Cardinality0...1
TypeCodeableConcept
Binding

Codes that provide further information about the reason and meaning of the item in the list.

PatientMedicineChangeTypes (example)
Requirements

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.

Comments

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".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
List.entry.deleted
DefinitionTrue if this item is marked as deleted in the list.
Cardinality0...1
Typeboolean
ModifierTrue
Requirements

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".

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: added: .updateMode=("A","AR") retained: .updateMode="NC" updated: .updateMode="R" deleted: .updateMode="D"
List.entry.date
DefinitionWhen this item was added to the list.
Cardinality0...1
TypedateTime
Requirements

The date may be significant for understanding the meaning of items in a working list.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .availabilityTime
List.entry.item
DefinitionA reference to the actual resource from which data was derived.
Cardinality1...1
TypeReference(EPAAllergyIntolerance)
Must SupportTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .target or .role or .role.entity
List.emptyReason
DefinitionHier kann der Grund abgebildet werden, warum eine Allergien/Unverträglichkeiten-Liste keine Einträge enthält. Der Grund ist im MIO Medikation auf "nilknown/Keine Einträge vorhanden" festgelegt und kann nur angegeben werden, wenn die Gruppe "Allergie/Unverträglichkeit-Eintrag" keine Referenzen enthält.
Cardinality0...1
TypeCodeableConcept
Binding

If a list is empty, why it is empty.

ListEmptyReasons (preferred)
Must SupportTrue
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
List.emptyReason.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.emptyReason.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.emptyReason.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
BindingEPAEmptyReasonCodeVS (required)
Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
List.emptyReason.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
List.emptyReason.coding.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
List.emptyReason.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
List.emptyReason.coding.version
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.
Cardinality0...1
Typestring
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
List.emptyReason.coding.code
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).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
List.emptyReason.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
List.emptyReason.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

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.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
List.emptyReason.text
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.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="epa-plan-allergy-intolerance-list" />
    <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-plan-allergy-intolerance-list" />
    <version value="1.1.1" />
    <name value="EPAPlanAllergyIntoleranceList" />
    <title value="EPA Plan AllergyIntolerance List" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="mio42 GmbH" />
    <description value="Dieses Profil bildet die Allergien/Unvertr&#228;glichkeiten f&#252;r den eMedikationsplan ab." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="List" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/List" />
    <derivation value="constraint" />
    <differential>
        <element id="List">
            <path value="List" />
            <definition value="Dieses Profil bildet die Liste von Allergien/Unvertr&#228;glichkeiten ab. Diese enth&#228;lt alle Allergie/Unvertr&#228;glichkeit-Eintr&#228;ge eines/einer Patient:in." />
        </element>
        <element id="List.meta">
            <path value="List.meta" />
            <mustSupport value="true" />
        </element>
        <element id="List.meta.versionId">
            <path value="List.meta.versionId" />
            <mustSupport value="true" />
        </element>
        <element id="List.meta.lastUpdated">
            <path value="List.meta.lastUpdated" />
            <mustSupport value="true" />
        </element>
        <element id="List.text">
            <path value="List.text" />
            <definition value="In diesem Element k&#246;nnen die, in der Instanz, enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden d&#252;rfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind." />
        </element>
        <element id="List.text.status">
            <path value="List.text.status" />
            <fixedCode value="extensions" />
        </element>
        <element id="List.status">
            <path value="List.status" />
            <definition value="Hier wird der Status einer Liste von Allergien/Unvertr&#228;glichkeiten abgebildet. Der Status der Liste ist im MIO Medikation auf &quot;current/aktuell&quot; festgesetzt." />
            <patternCode value="current" />
            <mustSupport value="true" />
        </element>
        <element id="List.mode">
            <path value="List.mode" />
            <definition value="Hier wird der Modus der Verarbeitung einer Liste von Allergien/Unvertr&#228;glichkeiten abgebildet. Im Rahmen der Erstellung einer solchen Liste innerhalb des MIO Medikation ist der Modus auf &quot;Snapshot/Momentaufnahme der Liste&quot; festgesetzt" />
            <patternCode value="snapshot" />
            <mustSupport value="true" />
        </element>
        <element id="List.code">
            <path value="List.code" />
            <definition value="Hier wird ein Code f&#252;r die Art der Liste angegeben. Die Art der Liste im MIO Medikation ist auf &quot;allergies/ Allergien/Unvertr&#228;glichkeiten&quot; festgesetzt." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="List.code.coding">
            <path value="List.code.coding" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa-medication/ValueSet/epa-plan-allergy-intolerance-list-code-vs" />
            </binding>
        </element>
        <element id="List.code.coding.system">
            <path value="List.code.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="List.code.coding.code">
            <path value="List.code.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="List.code.coding.display">
            <path value="List.code.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="List.subject">
            <path value="List.subject" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="List.subject.identifier">
            <path value="List.subject.identifier" />
            <min value="1" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="List.entry">
            <path value="List.entry" />
            <definition value="Hier k&#246;nnen Eintr&#228;ge f&#252;r Allergien oder Unvertr&#228;glichkeiten referenziert werden." />
            <mustSupport value="true" />
        </element>
        <element id="List.entry.item">
            <path value="List.entry.item" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="List.emptyReason">
            <path value="List.emptyReason" />
            <definition value="Hier kann der Grund abgebildet werden, warum eine Allergien/Unvertr&#228;glichkeiten-Liste keine Eintr&#228;ge enth&#228;lt. Der Grund ist im MIO Medikation auf &quot;nilknown/Keine Eintr&#228;ge vorhanden&quot; festgelegt und kann nur angegeben werden, wenn die Gruppe &quot;Allergie/Unvertr&#228;glichkeit-Eintrag&quot; keine Referenzen enth&#228;lt." />
            <mustSupport value="true" />
        </element>
        <element id="List.emptyReason.coding">
            <path value="List.emptyReason.coding" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa-medication/ValueSet/epa-empty-reason-code-vs" />
            </binding>
        </element>
        <element id="List.emptyReason.coding.system">
            <path value="List.emptyReason.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="List.emptyReason.coding.code">
            <path value="List.emptyReason.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="List.emptyReason.coding.display">
            <path value="List.emptyReason.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-plan-allergy-intolerance-list",
    "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-plan-allergy-intolerance-list",
    "version": "1.1.1",
    "name": "EPAPlanAllergyIntoleranceList",
    "title": "EPA Plan AllergyIntolerance List",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "mio42 GmbH",
    "description": "Dieses Profil bildet die Allergien/Unverträglichkeiten für den eMedikationsplan ab.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "List",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/List",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "List",
                "path": "List",
                "definition": "Dieses Profil bildet die Liste von Allergien/Unverträglichkeiten ab. Diese enthält alle Allergie/Unverträglichkeit-Einträge eines/einer Patient:in."
            },
            {
                "id": "List.meta",
                "path": "List.meta",
                "mustSupport": true
            },
            {
                "id": "List.meta.versionId",
                "path": "List.meta.versionId",
                "mustSupport": true
            },
            {
                "id": "List.meta.lastUpdated",
                "path": "List.meta.lastUpdated",
                "mustSupport": true
            },
            {
                "id": "List.text",
                "path": "List.text",
                "definition": "In diesem Element können die, in der Instanz, enthaltenen Informationen in einer menschenlesbaren Form zusammengefasst werden. Dabei ist zu beachten, dass keine Informationen aufgenommen werden dürfen, die nicht in strukturierter Form an anderer Stelle in der Instanz enthalten sind."
            },
            {
                "id": "List.text.status",
                "path": "List.text.status",
                "fixedCode": "extensions"
            },
            {
                "id": "List.status",
                "path": "List.status",
                "definition": "Hier wird der Status einer Liste von Allergien/Unverträglichkeiten abgebildet. Der Status der Liste ist im MIO Medikation auf \"current/aktuell\" festgesetzt.",
                "patternCode": "current",
                "mustSupport": true
            },
            {
                "id": "List.mode",
                "path": "List.mode",
                "definition": "Hier wird der Modus der Verarbeitung einer Liste von Allergien/Unverträglichkeiten abgebildet. Im Rahmen der Erstellung einer solchen Liste innerhalb des MIO Medikation ist der Modus auf \"Snapshot/Momentaufnahme der Liste\" festgesetzt",
                "patternCode": "snapshot",
                "mustSupport": true
            },
            {
                "id": "List.code",
                "path": "List.code",
                "definition": "Hier wird ein Code für die Art der Liste angegeben. Die Art der Liste im MIO Medikation ist auf \"allergies/ Allergien/Unverträglichkeiten\" festgesetzt.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "List.code.coding",
                "path": "List.code.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa-medication/ValueSet/epa-plan-allergy-intolerance-list-code-vs"
                }
            },
            {
                "id": "List.code.coding.system",
                "path": "List.code.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "List.code.coding.code",
                "path": "List.code.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "List.code.coding.display",
                "path": "List.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "List.subject",
                "path": "List.subject",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "List.subject.identifier",
                "path": "List.subject.identifier",
                "min": 1,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-kvid-10"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "List.entry",
                "path": "List.entry",
                "definition": "Hier können Einträge für Allergien oder Unverträglichkeiten referenziert werden.",
                "mustSupport": true
            },
            {
                "id": "List.entry.item",
                "path": "List.entry.item",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "List.emptyReason",
                "path": "List.emptyReason",
                "definition": "Hier kann der Grund abgebildet werden, warum eine Allergien/Unverträglichkeiten-Liste keine Einträge enthält. Der Grund ist im MIO Medikation auf \"nilknown/Keine Einträge vorhanden\" festgelegt und kann nur angegeben werden, wenn die Gruppe \"Allergie/Unverträglichkeit-Eintrag\" keine Referenzen enthält.",
                "mustSupport": true
            },
            {
                "id": "List.emptyReason.coding",
                "path": "List.emptyReason.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa-medication/ValueSet/epa-empty-reason-code-vs"
                }
            },
            {
                "id": "List.emptyReason.coding.system",
                "path": "List.emptyReason.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "List.emptyReason.coding.code",
                "path": "List.emptyReason.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "List.emptyReason.coding.display",
                "path": "List.emptyReason.coding.display",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}


Informationsmodell als LogicalModel

Das Profil basiert auf folgendem Informationsmodell:

status1..1CodingFixed Value
modusDerVerarbeitung1..1CodingFixed Value
code1..1CodingBinding
aktualisierungszeitpunkt1..1dateTime
allergieUnvertraeglichkeit1..1Reference()
begruendungFuerEineLeereListeCodeI0..*CodingBinding


Beispiele

{
    "resourceType": "List",
    "id": "4a3848ab-5462-4fcd-a30c-4ea8ea4a12dc",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2024-01-01T00:00:00Z",
        "profile":  [
            "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-plan-allergy-intolerance-list"
        ]
    },
    "status": "current",
    "mode": "snapshot",
    "subject": {
        "identifier": {
            "system": "http://fhir.de/sid/gkv/kvid-10",
            "value": "X110411319"
        },
        "reference": "Patient/8c2c989e-199a-4ca3-994c-e9ac9e69c7be"
    },
    "code": {
        "coding":  [
            {
                "code": "allergies",
                "system": "http://terminology.hl7.org/CodeSystem/list-example-use-codes",
                "display": "Allergies"
            }
        ]
    },
    "entry":  [
        {
            "item": {
                "reference": "AllergyIntolerance/c4914762-59bb-451f-943b-98cd4f3a3d97"
            }
        }
    ]
}
<List xmlns="http://hl7.org/fhir">
    <id value="4a3848ab-5462-4fcd-a30c-4ea8ea4a12dc" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2024-01-01T00:00:00Z" />
        <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-plan-allergy-intolerance-list" />
    </meta>
    <status value="current" />
    <mode value="snapshot" />
    <code>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/list-example-use-codes" />
            <code value="allergies" />
            <display value="Allergies" />
        </coding>
    </code>
    <subject>
        <reference value="Patient/8c2c989e-199a-4ca3-994c-e9ac9e69c7be" />
        <identifier>
            <system value="http://fhir.de/sid/gkv/kvid-10" />
            <value value="X110411319" />
        </identifier>
    </subject>
    <entry>
        <item>
            <reference value="AllergyIntolerance/c4914762-59bb-451f-943b-98cd4f3a3d97" />
        </item>
    </entry>
</List>