EPAAllergyIntolerance

Das EPAAllergyIntolerance-Profil bildet Allergien oder Unverträglichkeiten ab. Es wird im Kontext von Arzneimitteltherapiesicherheitsrelevanten Zusatzinformationen (AMTS-rZI) dem Medication Service hinzugefügt. Diese Ressource enthält Informationen über bekannte allergische Reaktionen oder Unverträglichkeiten eines/einer Patient:in gegenüber bestimmten Substanzen, einschließlich Medikamenten. Diese Daten können dem elektronischen Medikationsplan hinzugefügt werden, um eine umfassende und sichere Arzneimitteltherapie zu gewährleisten.


Profil für gemeinsame Datengrundlage im ePA Medication Service

EPA Allergy Intolerance Profile

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
abatementS I0..1Extension(dateTime)
abatement-phase-untilS I0..1Extension(CodeableConcept)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
typeS Σ0..1codeBinding
categoryS Σ0..1codeBinding
criticalityS Σ0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierS Σ1..1IdentifierKvid10
displayΣ0..1string
encounterI0..1Reference(Encounter)
onsetDateTimeS0..1dateTime
id0..1string
phase-fromS I0..1Extension(CodeableConcept)
valueΣ0..1decimal
comparatorΣ ?!0..1codeBinding
unitΣ0..1string
systemΣ I0..1uri
codeΣ0..1code
id0..1string
extensionI0..*Extension
startS Σ I0..1dateTime
endS Σ I0..1dateTime
recordedDate0..1dateTime
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..1uriBinding
identifierS Σ0..1IdentifierKvid10, IdentifierTelematikId
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..1uriBinding
identifierS Σ0..1IdentifierKvid10, IdentifierTelematikId
displayΣ0..1string
lastOccurrence0..1dateTime
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..1uriBinding
identifierS Σ0..1IdentifierKvid10, IdentifierTelematikId
displayΣ0..1string
timeS Σ0..1dateTime
textS Σ1..1markdown
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
descriptionS0..1string
onsetS0..1dateTime
severityS0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
note0..*Annotation
AllergyIntolerance
DefinitionDieses Profil bildet eine Allergie oder Unverträglichkeit ab.
Cardinality0...*
AliasAllergy, Intolerance, Adverse Reaction
Comments

Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

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()
  • ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
  • ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
Mappings
  • rim: Entity. Role, or Act
  • rim: Observation[classCode=OBS, moodCode=EVN]
AllergyIntolerance.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.

AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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?
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
Must SupportTrue
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
AllergyIntolerance.extension:abatement
DefinitionIn diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unverträglichkeit hatte.
Cardinality0...1
TypeExtension(dateTime)
Must SupportTrue
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.

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
AllergyIntolerance.extension:abatement-phase-until
DefinitionAngabe des ungefähren Alters, ab dem der/die Patient:in die Allergie/Unverträglichkeit nicht mehr hat.
Cardinality0...1
TypeExtension(CodeableConcept)
Must SupportTrue
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.

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
AllergyIntolerance.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
AllergyIntolerance.identifier
DefinitionBusiness identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Cardinality0...*
TypeIdentifier
SummaryTrue
Requirements

Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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
  • v2: IAM-7
  • rim: id
AllergyIntolerance.clinicalStatus
DefinitionBeschreibt den Status einer Allergie bzw. Unverträglichkeit aus klinischer Sicht.
Cardinality0...1
TypeCodeableConcept
Binding

The clinical status of the allergy or intolerance.

AllergyIntoleranceClinicalStatusCodes (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

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.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...*
TypeCoding
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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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 ]
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.verificationStatus
DefinitionGibt den Grad der Sicherheit oder Gewissheit an, mit der das tatsächliche Vorliegen der Allergie/Unverträglichkeit angegeben werden kann.
Cardinality0...1
TypeCodeableConcept
Binding

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

AllergyIntoleranceVerificationStatusCodes (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

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.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...*
TypeCoding
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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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 ]
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.type
DefinitionIn diesem Element kann angegeben werden, ob es sich um eine Allergie oder eine Unverträglichkeit handelt
Cardinality0...1
Typecode
Binding

Identification of the underlying physiological mechanism for a Reaction Risk.

AllergyIntoleranceType (required)
Must SupportTrue
SummaryTrue
AliasCategory, Class
Comments

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • v2: IAM-9
  • rim: code
AllergyIntolerance.category
DefinitionEnthält die Kategorie der die Allergie oder Unverträglichkeit auslösenden Substanz gemäß den angegebenen Auswahlmöglichkeiten.
Cardinality0...1
Typecode
Binding

Category of an identified substance associated with allergies or intolerances.

AllergyIntoleranceCategory (required)
Must SupportTrue
SummaryTrue
AliasCategory, Type, Reaction Type, Class
Comments

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • v2: AL1-2
  • rim: value < IntoleranceValue (Agent)
AllergyIntolerance.criticality
DefinitionBeschreibt die Kritikalität. Die Kritikalität gibt an, wie hoch Risiko dafür ist, dass die Exposition zu der Substanz eine schwerwiegende oder lebensbedrohliche Situation hervorruft.
Cardinality0...1
Typecode
Binding

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

AllergyIntoleranceCriticality (required)
Must SupportTrue
SummaryTrue
AliasSeverity, Seriousness, Contra-indication, Risk
Comments

The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.grade
  • v2: AL1-4
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
AllergyIntolerance.code
DefinitionDieses Element bildet die Substanz bzw. Substanzgruppen ab, gegen die eine Allergie oder Unverträglichkeit besteht. Diese kann als codierte Information und/oder als Freitext angegeben werden.
Cardinality1...1
TypeCodeableConcept
Binding

Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
Must SupportTrue
SummaryTrue
AliasCode
Comments

It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.

The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

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]
  • v2: AL1-3 / IAM-3
  • rim: substance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.code.coding
DefinitionHier kann die Substanz als codierte Information angegeben werden.
Cardinality0...*
TypeCoding
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.

SlicingUnordered, Open, by $this(Value)
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
AllergyIntolerance.code.coding:snomed
DefinitionHier kann ein SNOMED CT®-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCoding
BindingEPASubstanceSNOMEDCTVS (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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.code.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.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 ]
AllergyIntolerance.code.coding:ask
DefinitionHier kann ein ASK-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingASK
BindingASK (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.

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

{
  "system": "http://fhir.de/CodeSystem/ask"
}

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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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())
Fixed Value

http://fhir.de/CodeSystem/ask

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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 ]
AllergyIntolerance.code.coding:atc-de
DefinitionHier kann ein deutscher ATC-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingATC
BindingATC (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.

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

{
  "system": "http://fhir.de/CodeSystem/bfarm/atc"
}

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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.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())
Fixed Value

http://fhir.de/CodeSystem/bfarm/atc

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.code.coding:atc-de.version
DefinitionBie Verwendung von ATC ist die Angabe der Version zwingend erforderlich. Hierdurch wird der Tatsache Rechnung getragen, dass jede der jährlich neu erscheinenden Fassung von ATC ein neues Codesystem darstellt.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.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 ]
AllergyIntolerance.code.text
DefinitionHier kann die Bezeichnung der Substanz als Freitext angegeben werden.
Cardinality0...1
Typestring
Must SupportTrue
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
AllergyIntolerance.patient
DefinitionThe patient who has the allergy or intolerance.
Cardinality1...1
TypeReference(Patient)
Must SupportTrue
SummaryTrue
AliasPatient
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.subject[x]
  • v2: (PID-3)
  • rim: .participation[typeCode=SBJ].role[classCode=PAT]
  • w5: FiveWs.subject
AllergyIntolerance.patient.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
AllergyIntolerance.patient.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
AllergyIntolerance.patient.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
AllergyIntolerance.patient.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
AllergyIntolerance.patient.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
AllergyIntolerance.patient.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
AllergyIntolerance.encounter
DefinitionThe encounter when the allergy or intolerance was asserted.
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]
AllergyIntolerance.onset[x]
DefinitionIn diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unverträglichkeit hatte bzw. hat.
Cardinality0...1
TypedateTime
SlicingUnordered, Open, by $this(Type)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetDateTime
DefinitionDatum, ab wann die Allergie/Unverträglichkeit identifiziert wurde.
Cardinality0...1
TypedateTime
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetAge
DefinitionAngabe der Lebensphasen, in denen die Allergie/Unverträglichkeit begonnen hat.
Cardinality0...1
TypeAge
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetAge.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
AllergyIntolerance.onset[x]:onsetAge.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
Must SupportTrue
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
AllergyIntolerance.onset[x]:onsetAge.extension:phase-from
DefinitionAngabe des ungefähren Alters, ab dem der/die Patient:in die Allergie/Unverträglichkeit hat.
Cardinality0...1
TypeExtension(CodeableConcept)
Must SupportTrue
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.

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
AllergyIntolerance.onset[x]:onsetAge.value
DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value.
Cardinality0...1
Typedecimal
SummaryTrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SN.2 / CQ - N/A
  • rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
AllergyIntolerance.onset[x]:onsetAge.comparator
DefinitionHow the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Cardinality0...1
Typecode
Binding

How the Quantity should be understood and represented.

QuantityComparator (required)
ModifierTrue
SummaryTrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

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: SN.1 / CQ.1
  • rim: IVL properties
AllergyIntolerance.onset[x]:onsetAge.unit
DefinitionA human-readable form of the unit.
Cardinality0...1
Typestring
SummaryTrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

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: (see OBX.6 etc.) / CQ.2
  • rim: PQ.unit
AllergyIntolerance.onset[x]:onsetAge.system
DefinitionThe identification of the system that provides the coded form of the unit.
Cardinality0...1
Typeuri
SummaryTrue
Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: CO.codeSystem, PQ.translation.codeSystem
AllergyIntolerance.onset[x]:onsetAge.code
DefinitionA computer processable form of the unit in some unit representation system.
Cardinality0...1
Typecode
SummaryTrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.code, MO.currency, PQ.translation.code
AllergyIntolerance.onset[x]:onsetPeriod
DefinitionKlinisch relevanter Zeitraum als Zeitintervall mit Datumsangaben, ab/bis wann der/die Patient:in die Allergie/Unverträglichkeit hatte bzw. hat.
Cardinality0...1
TypePeriod
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetPeriod.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
AllergyIntolerance.onset[x]:onsetPeriod.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
AllergyIntolerance.onset[x]:onsetPeriod.start
DefinitionDatum, ab wann die Allergie/Unverträglichkeit identifiziert wurde.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: DR.1
  • rim: ./low
AllergyIntolerance.onset[x]:onsetPeriod.end
DefinitionDatum, bis wann der/die Patient:in die Allergie/Unverträglichkeit hatte.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: DR.2
  • rim: ./high
AllergyIntolerance.recordedDate
DefinitionThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
Cardinality0...1
TypedateTime
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
  • v2: IAM-13
  • rim: .participation[typeCode=AUT].time
AllergyIntolerance.recorder
DefinitionHier wird die Aufzeichnende Person der "Allergie/Unverträglichkeit" referenziert.
Cardinality0...1
TypeReference(RelatedPerson | Practitioner | PractitionerRole)
Must SupportTrue
AliasAuthor
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.author
  • rim: .participation[typeCode=AUT].role
AllergyIntolerance.recorder.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
AllergyIntolerance.recorder.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
AllergyIntolerance.recorder.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
Must SupportTrue
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
AllergyIntolerance.recorder.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
AllergyIntolerance.recorder.identifier
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.
Cardinality0...1
TypeIdentifierKvid10, IdentifierTelematikId
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
AllergyIntolerance.recorder.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
AllergyIntolerance.asserter
DefinitionHier wird die Quelle der Information der "Allergie/Unverträglichkeit" abgebildet.
Cardinality0...1
TypeReference(Patient | RelatedPerson | Practitioner | PractitionerRole)
Must SupportTrue
SummaryTrue
AliasSource, Informant
Comments

The recorder takes responsibility for the content, but can reference the source from where they got it.

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.source
  • v2: IAM-14 (if patient) / IAM-18 (if practitioner)
  • rim: .participation[typeCode=INF].role
AllergyIntolerance.asserter.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
AllergyIntolerance.asserter.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
AllergyIntolerance.asserter.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
Must SupportTrue
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
AllergyIntolerance.asserter.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
AllergyIntolerance.asserter.identifier
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.
Cardinality0...1
TypeIdentifierKvid10, IdentifierTelematikId
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
AllergyIntolerance.asserter.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
AllergyIntolerance.lastOccurrence
DefinitionRepresents the date and/or time of the last known occurrence of a reaction event.
Cardinality0...1
TypedateTime
Comments

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

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=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime
AllergyIntolerance.note
DefinitionHier können ergänzende Informationen zur Allergie bzw. Unverträglichkeit angegeben werden.
Cardinality0...*
TypeAnnotation
Must SupportTrue
Comments

For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

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: subjectOf.observationEvent[code="annotation"].value
AllergyIntolerance.note.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
AllergyIntolerance.note.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
AllergyIntolerance.note.author[x]
DefinitionHier wird die Person/Einrichtung referenziert, die die Notiz erstellt hat.
Cardinality0...1
TypeReference(Practitioner | Patient | RelatedPerson | Organization)
Must SupportTrue
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

SlicingUnordered, Closed, by $this(Type)
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.participant[typeCode=AUT].role
AllergyIntolerance.note.author[x]:authorReference
DefinitionThe individual responsible for making the annotation.
Cardinality0...1
TypeReference(Organization | Patient | Practitioner)
Must SupportTrue
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

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.participant[typeCode=AUT].role
AllergyIntolerance.note.author[x]:authorReference.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
AllergyIntolerance.note.author[x]:authorReference.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
AllergyIntolerance.note.author[x]:authorReference.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
Must SupportTrue
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
AllergyIntolerance.note.author[x]:authorReference.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
AllergyIntolerance.note.author[x]:authorReference.identifier
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.
Cardinality0...1
TypeIdentifierKvid10, IdentifierTelematikId
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
AllergyIntolerance.note.author[x]:authorReference.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
AllergyIntolerance.note.time
DefinitionHier wird der Zeitpunkt angegeben, zu dem die Notiz erstellt wurde.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

Dieses Element sollte in der Regel automatisiert ohne Aufwand für die Person, die die Notiz erstellt befüllt werden.

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.effectiveTime
AllergyIntolerance.note.text
DefinitionHier wird der eigentliche Text der Notiz eingetragen.
Cardinality1...1
Typemarkdown
Must SupportTrue
SummaryTrue
Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

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.text
AllergyIntolerance.reaction
DefinitionDieses Element enthält Informationen über die Reaktion, die bei diesem/dieser Patient:in nach Exposition hervorgerufen wird.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
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=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]
AllergyIntolerance.reaction.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
AllergyIntolerance.reaction.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
AllergyIntolerance.reaction.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
AllergyIntolerance.reaction.substance
DefinitionDieses Element bildet die spezifische Substanz ab, welche die Reaktion hervorruft.
Cardinality0...1
TypeCodeableConcept
Binding

Codes defining the type of the substance (including pharmaceutical products).

SubstanceCode (example)
Must SupportTrue
Comments

Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in '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
  • rim: outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]
AllergyIntolerance.reaction.substance.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
AllergyIntolerance.reaction.substance.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
AllergyIntolerance.reaction.substance.coding
DefinitionDieses Element bildet die Substanz als codierte Information ab.
Cardinality0...*
TypeCoding
Must SupportTrue
SummaryTrue
Requirements

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

Comments

Das MustSupport gilt nur für die vordefinierten Slices.

SlicingUnordered, Open, by $this(Value)
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
AllergyIntolerance.reaction.substance.coding:snomed
DefinitionHier kann ein SNOMED CT®-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCoding
BindingEPASubstanceSNOMEDCTVS (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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.substance.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.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 ]
AllergyIntolerance.reaction.substance.coding:ask
DefinitionHier kann ein ASK-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingASK
BindingASK (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.

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

{
  "system": "http://fhir.de/CodeSystem/ask"
}

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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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())
Fixed Value

http://fhir.de/CodeSystem/ask

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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 ]
AllergyIntolerance.reaction.substance.coding:atc-de
DefinitionHier kann ein deutscher ATC-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingATC
BindingATC (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.

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

{
  "system": "http://fhir.de/CodeSystem/bfarm/atc"
}

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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.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())
Fixed Value

http://fhir.de/CodeSystem/bfarm/atc

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.substance.coding:atc-de.version
DefinitionBie Verwendung von ATC ist die Angabe der Version zwingend erforderlich. Hierdurch wird der Tatsache Rechnung getragen, dass jede der jährlich neu erscheinenden Fassung von ATC ein neues Codesystem darstellt.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.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 ]
AllergyIntolerance.reaction.substance.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
Must SupportTrue
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
AllergyIntolerance.reaction.manifestation
DefinitionIn diesem Element können Angaben zur Manifestation der Reaktion gemacht werden.
Cardinality1...*
TypeCodeableConcept
Binding

Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.

SNOMEDCTClinicalFindings (example)
Must SupportTrue
AliasSymptoms, Signs
Comments

Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.

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
  • v2: AL1-5
  • rim: code
AllergyIntolerance.reaction.manifestation.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
AllergyIntolerance.reaction.manifestation.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
AllergyIntolerance.reaction.manifestation.coding
DefinitionHier kann die Manifestation als codierte Information angegeben werden.
Cardinality0...*
TypeCoding
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.

SlicingUnordered, Open, by $this(Value)
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
AllergyIntolerance.reaction.manifestation.coding:snomed
DefinitionManifestation als SNOMED CT®-Code.
Cardinality0...1
TypeCoding
BindingEPAAllergyIntoleranceReactionSNOMEDCTVS (extensible)
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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.manifestation.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.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 ]
AllergyIntolerance.reaction.manifestation.text
DefinitionBezeichnung bzw. Beschreibung der Manifestation als Freitext.
Cardinality0...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.description
DefinitionText description about the reaction as a whole, including details of the manifestation if required.
Cardinality0...1
Typestring
Must SupportTrue
AliasNarrative, Text
Comments

Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: text
AllergyIntolerance.reaction.onset
DefinitionDatum eines Reaktionsereignisses.
Cardinality0...1
TypedateTime
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: AL1-6
  • rim: effectiveTime.low
AllergyIntolerance.reaction.severity
DefinitionDieses Element enthält Informationen zum Schweregrad der Reaktion.
Cardinality0...1
Typecode
Binding

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

AllergyIntoleranceSeverity (required)
Must SupportTrue
Comments

It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
AllergyIntolerance.reaction.exposureRoute
DefinitionHier kann der Expositionsweg des Allergens angegeben werden.
Cardinality0...1
TypeCodeableConcept
Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

SNOMEDCTRouteCodes (example)
Must SupportTrue
Comments

Coding of the route of exposure with a terminology should be used wherever possible.

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=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode
AllergyIntolerance.reaction.exposureRoute.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
AllergyIntolerance.reaction.exposureRoute.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
AllergyIntolerance.reaction.exposureRoute.coding
DefinitionHier kann der Expositionsweg als codierte Information angegeben werden.
Cardinality0...*
TypeCoding
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.

SlicingUnordered, Open, by $this(Value)
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
AllergyIntolerance.reaction.exposureRoute.coding:snomed
DefinitionSNOMED CT®-Code für die Bezeichnung des Expositionswegs.
Cardinality0...1
TypeCoding
BindingEPARouteOfAdministrationSNOMEDCTVS (extensible)
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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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 ]
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode
DefinitionEDQM-Code für die Bezeichnung des Expositionswegs.
Cardinality0...1
TypeCoding
BindingEPAMedicineRouteOfAdministrationEDQMVS (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())
Pattern

{
  "system": "http://standardterms.edqm.eu"
}

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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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())
Pattern

http://standardterms.edqm.eu

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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 ]
AllergyIntolerance.reaction.exposureRoute.text
DefinitionHier kann der Expositionsweg als Freitext angegeben werden.
Cardinality0...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.note
DefinitionAdditional text about the adverse reaction event not captured in other fields.
Cardinality0...*
TypeAnnotation
Comments

Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.

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: subjectOf.observationEvent[code="annotation"].value
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="epa-allergy-intolerance" />
    <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance" />
    <version value="1.1.0" />
    <name value="EPAAllergyIntolerance" />
    <title value="EPA Allergy Intolerance Profile" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="mio42 GmbH" />
    <description value="Dieses Profil bildet eine Allergie oder Unvertr&#228;glichkeit ab." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="AllergyIntolerance" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/AllergyIntolerance" />
    <derivation value="constraint" />
    <differential>
        <element id="AllergyIntolerance">
            <path value="AllergyIntolerance" />
            <definition value="Dieses Profil bildet eine Allergie oder Unvertr&#228;glichkeit ab." />
        </element>
        <element id="AllergyIntolerance.meta">
            <path value="AllergyIntolerance.meta" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.meta.versionId">
            <path value="AllergyIntolerance.meta.versionId" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.meta.lastUpdated">
            <path value="AllergyIntolerance.meta.lastUpdated" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.text">
            <path value="AllergyIntolerance.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="AllergyIntolerance.text.status">
            <path value="AllergyIntolerance.text.status" />
            <fixedCode value="extensions" />
        </element>
        <element id="AllergyIntolerance.extension">
            <path value="AllergyIntolerance.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <description value="Extensions are always sliced by (at least) url" />
                <ordered value="false" />
                <rules value="open" />
            </slicing>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.extension:abatement">
            <path value="AllergyIntolerance.extension" />
            <sliceName value="abatement" />
            <short value="Klinisch relevantes Enddatum" />
            <definition value="In diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unvertr&#228;glichkeit hatte." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance-abatement-extension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.extension:abatement-phase-until">
            <path value="AllergyIntolerance.extension" />
            <sliceName value="abatement-phase-until" />
            <short value="abatement-lebensphase-bis" />
            <definition value="Angabe des ungef&#228;hren Alters, ab dem der/die Patient:in die Allergie/Unvertr&#228;glichkeit nicht mehr hat." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-stage-life-extension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus">
            <path value="AllergyIntolerance.clinicalStatus" />
            <definition value="Beschreibt den Status einer Allergie bzw. Unvertr&#228;glichkeit aus klinischer Sicht." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus.coding">
            <path value="AllergyIntolerance.clinicalStatus.coding" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus.coding.system">
            <path value="AllergyIntolerance.clinicalStatus.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus.coding.version">
            <path value="AllergyIntolerance.clinicalStatus.coding.version" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus.coding.code">
            <path value="AllergyIntolerance.clinicalStatus.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus.coding.display">
            <path value="AllergyIntolerance.clinicalStatus.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.verificationStatus">
            <path value="AllergyIntolerance.verificationStatus" />
            <definition value="Gibt den Grad der Sicherheit oder Gewissheit an, mit der das tats&#228;chliche Vorliegen der Allergie/Unvertr&#228;glichkeit angegeben werden kann." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.verificationStatus.coding">
            <path value="AllergyIntolerance.verificationStatus.coding" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.verificationStatus.coding.system">
            <path value="AllergyIntolerance.verificationStatus.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.verificationStatus.coding.version">
            <path value="AllergyIntolerance.verificationStatus.coding.version" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.verificationStatus.coding.code">
            <path value="AllergyIntolerance.verificationStatus.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.verificationStatus.coding.display">
            <path value="AllergyIntolerance.verificationStatus.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.type">
            <path value="AllergyIntolerance.type" />
            <definition value="In diesem Element kann angegeben werden, ob es sich um eine Allergie oder eine Unvertr&#228;glichkeit handelt" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.category">
            <path value="AllergyIntolerance.category" />
            <definition value="Enth&#228;lt die Kategorie der die Allergie oder Unvertr&#228;glichkeit ausl&#246;senden Substanz gem&#228;&#223; den angegebenen Auswahlm&#246;glichkeiten." />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.criticality">
            <path value="AllergyIntolerance.criticality" />
            <definition value="Beschreibt die Kritikalit&#228;t. Die Kritikalit&#228;t gibt an, wie hoch Risiko daf&#252;r ist, dass die Exposition zu der Substanz eine schwerwiegende oder lebensbedrohliche Situation hervorruft." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code">
            <path value="AllergyIntolerance.code" />
            <definition value="Dieses Element bildet die Substanz bzw. Substanzgruppen ab, gegen die eine Allergie oder Unvertr&#228;glichkeit besteht. Diese kann als codierte Information und/oder als Freitext angegeben werden." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding">
            <path value="AllergyIntolerance.code.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <definition value="Hier kann die Substanz als codierte Information angegeben werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:snomed">
            <path value="AllergyIntolerance.code.coding" />
            <sliceName value="snomed" />
            <definition value="Hier kann ein SNOMED CT&#174;-Code f&#252;r die Substanz angegeben werden." />
            <min value="0" />
            <max value="1" />
            <patternCoding>
                <system value="http://snomed.info/sct" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" />
            </binding>
        </element>
        <element id="AllergyIntolerance.code.coding:snomed.system">
            <path value="AllergyIntolerance.code.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:snomed.version">
            <path value="AllergyIntolerance.code.coding.version" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:snomed.code">
            <path value="AllergyIntolerance.code.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:snomed.display">
            <path value="AllergyIntolerance.code.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:ask">
            <path value="AllergyIntolerance.code.coding" />
            <sliceName value="ask" />
            <definition value="Hier kann ein ASK-Code f&#252;r die Substanz angegeben werden." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Coding" />
                <profile value="http://fhir.de/StructureDefinition/CodingASK" />
            </type>
            <patternCoding>
                <system value="http://fhir.de/CodeSystem/ask" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://fhir.de/ValueSet/ask" />
            </binding>
        </element>
        <element id="AllergyIntolerance.code.coding:ask.system">
            <path value="AllergyIntolerance.code.coding.system" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:ask.code">
            <path value="AllergyIntolerance.code.coding.code" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:ask.display">
            <path value="AllergyIntolerance.code.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:atc-de">
            <path value="AllergyIntolerance.code.coding" />
            <sliceName value="atc-de" />
            <definition value="Hier kann ein deutscher ATC-Code f&#252;r die Substanz angegeben werden." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Coding" />
                <profile value="http://fhir.de/StructureDefinition/CodingATC" />
            </type>
            <patternCoding>
                <system value="http://fhir.de/CodeSystem/bfarm/atc" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://fhir.de/ValueSet/bfarm/atc" />
            </binding>
        </element>
        <element id="AllergyIntolerance.code.coding:atc-de.system">
            <path value="AllergyIntolerance.code.coding.system" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:atc-de.version">
            <path value="AllergyIntolerance.code.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:atc-de.code">
            <path value="AllergyIntolerance.code.coding.code" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.coding:atc-de.display">
            <path value="AllergyIntolerance.code.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.code.text">
            <path value="AllergyIntolerance.code.text" />
            <definition value="Hier kann die Bezeichnung der Substanz als Freitext angegeben werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.patient">
            <path value="AllergyIntolerance.patient" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.patient.identifier">
            <path value="AllergyIntolerance.patient.identifier" />
            <min value="1" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.onset[x]">
            <path value="AllergyIntolerance.onset[x]" />
            <slicing>
                <discriminator>
                    <type value="type" />
                    <path value="$this" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
            <definition value="In diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unvertr&#228;glichkeit hatte bzw. hat." />
            <type>
                <code value="dateTime" />
            </type>
            <type>
                <code value="Age" />
            </type>
            <type>
                <code value="Period" />
            </type>
        </element>
        <element id="AllergyIntolerance.onset[x]:onsetDateTime">
            <path value="AllergyIntolerance.onset[x]" />
            <sliceName value="onsetDateTime" />
            <short value="Klinischer Zeitraum datiert &quot;von&quot;" />
            <definition value="Datum, ab wann die Allergie/Unvertr&#228;glichkeit identifiziert wurde." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="dateTime" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.onset[x]:onsetAge">
            <path value="AllergyIntolerance.onset[x]" />
            <sliceName value="onsetAge" />
            <short value="Klinischer Zeitraum" />
            <definition value="Angabe der Lebensphasen, in denen die Allergie/Unvertr&#228;glichkeit begonnen hat." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Age" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.onset[x]:onsetAge.extension">
            <path value="AllergyIntolerance.onset[x].extension" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.onset[x]:onsetAge.extension:phase-from">
            <path value="AllergyIntolerance.onset[x].extension" />
            <sliceName value="phase-from" />
            <short value="lebensphase-von" />
            <definition value="Angabe des ungef&#228;hren Alters, ab dem der/die Patient:in die Allergie/Unvertr&#228;glichkeit hat." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-stage-life-extension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.onset[x]:onsetPeriod">
            <path value="AllergyIntolerance.onset[x]" />
            <sliceName value="onsetPeriod" />
            <definition value="Klinisch relevanter Zeitraum als Zeitintervall mit Datumsangaben, ab/bis wann der/die Patient:in die Allergie/Unvertr&#228;glichkeit hatte bzw. hat." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Period" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.onset[x]:onsetPeriod.start">
            <path value="AllergyIntolerance.onset[x].start" />
            <definition value="Datum, ab wann die Allergie/Unvertr&#228;glichkeit identifiziert wurde." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.onset[x]:onsetPeriod.end">
            <path value="AllergyIntolerance.onset[x].end" />
            <definition value="Datum, bis wann der/die Patient:in die Allergie/Unvertr&#228;glichkeit hatte." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.recorder">
            <path value="AllergyIntolerance.recorder" />
            <definition value="Hier wird die Aufzeichnende Person der &quot;Allergie/Unvertr&#228;glichkeit&quot; referenziert." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.recorder.reference">
            <path value="AllergyIntolerance.recorder.reference" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.recorder.identifier">
            <path value="AllergyIntolerance.recorder.identifier" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" />
                <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.asserter">
            <path value="AllergyIntolerance.asserter" />
            <definition value="Hier wird die Quelle der Information der &quot;Allergie/Unvertr&#228;glichkeit&quot; abgebildet." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.asserter.reference">
            <path value="AllergyIntolerance.asserter.reference" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.asserter.identifier">
            <path value="AllergyIntolerance.asserter.identifier" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" />
                <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.note">
            <path value="AllergyIntolerance.note" />
            <definition value="Hier k&#246;nnen erg&#228;nzende Informationen zur Allergie bzw. Unvertr&#228;glichkeit angegeben werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.note.author[x]">
            <path value="AllergyIntolerance.note.author[x]" />
            <slicing>
                <discriminator>
                    <type value="type" />
                    <path value="$this" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <definition value="Hier wird die Person/Einrichtung referenziert, die die Notiz erstellt hat." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.note.author[x]:authorReference">
            <path value="AllergyIntolerance.note.author[x]" />
            <sliceName value="authorReference" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.note.author[x]:authorReference.reference">
            <path value="AllergyIntolerance.note.author[x].reference" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.note.author[x]:authorReference.identifier">
            <path value="AllergyIntolerance.note.author[x].identifier" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" />
                <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.note.time">
            <path value="AllergyIntolerance.note.time" />
            <definition value="Hier wird der Zeitpunkt angegeben, zu dem die Notiz erstellt wurde." />
            <comment value="Dieses Element sollte in der Regel automatisiert ohne Aufwand f&#252;r die Person, die die Notiz erstellt bef&#252;llt werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.note.text">
            <path value="AllergyIntolerance.note.text" />
            <definition value="Hier wird der eigentliche Text der Notiz eingetragen." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction">
            <path value="AllergyIntolerance.reaction" />
            <definition value="Dieses Element enth&#228;lt Informationen &#252;ber die Reaktion, die bei diesem/dieser Patient:in nach Exposition hervorgerufen wird." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance">
            <path value="AllergyIntolerance.reaction.substance" />
            <definition value="Dieses Element bildet die spezifische Substanz ab, welche die Reaktion hervorruft." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <definition value="Dieses Element bildet die Substanz als codierte Information ab." />
            <comment value="Das MustSupport gilt nur f&#252;r die vordefinierten Slices." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:snomed">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <sliceName value="snomed" />
            <definition value="Hier kann ein SNOMED CT&#174;-Code f&#252;r die Substanz angegeben werden." />
            <min value="0" />
            <max value="1" />
            <patternCoding>
                <system value="http://snomed.info/sct" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" />
            </binding>
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:snomed.system">
            <path value="AllergyIntolerance.reaction.substance.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:snomed.version">
            <path value="AllergyIntolerance.reaction.substance.coding.version" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:snomed.code">
            <path value="AllergyIntolerance.reaction.substance.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:snomed.display">
            <path value="AllergyIntolerance.reaction.substance.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:ask">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <sliceName value="ask" />
            <definition value="Hier kann ein ASK-Code f&#252;r die Substanz angegeben werden." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Coding" />
                <profile value="http://fhir.de/StructureDefinition/CodingASK" />
            </type>
            <patternCoding>
                <system value="http://fhir.de/CodeSystem/ask" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://fhir.de/ValueSet/ask" />
            </binding>
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:ask.system">
            <path value="AllergyIntolerance.reaction.substance.coding.system" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:ask.code">
            <path value="AllergyIntolerance.reaction.substance.coding.code" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:ask.display">
            <path value="AllergyIntolerance.reaction.substance.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:atc-de">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <sliceName value="atc-de" />
            <definition value="Hier kann ein deutscher ATC-Code f&#252;r die Substanz angegeben werden." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Coding" />
                <profile value="http://fhir.de/StructureDefinition/CodingATC" />
            </type>
            <patternCoding>
                <system value="http://fhir.de/CodeSystem/bfarm/atc" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://fhir.de/ValueSet/bfarm/atc" />
            </binding>
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:atc-de.system">
            <path value="AllergyIntolerance.reaction.substance.coding.system" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:atc-de.version">
            <path value="AllergyIntolerance.reaction.substance.coding.version" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:atc-de.code">
            <path value="AllergyIntolerance.reaction.substance.coding.code" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:atc-de.display">
            <path value="AllergyIntolerance.reaction.substance.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.text">
            <path value="AllergyIntolerance.reaction.substance.text" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation">
            <path value="AllergyIntolerance.reaction.manifestation" />
            <definition value="In diesem Element k&#246;nnen Angaben zur Manifestation der Reaktion gemacht werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding">
            <path value="AllergyIntolerance.reaction.manifestation.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <definition value="Hier kann die Manifestation als codierte Information angegeben werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding:snomed">
            <path value="AllergyIntolerance.reaction.manifestation.coding" />
            <sliceName value="snomed" />
            <definition value="Manifestation als SNOMED CT&#174;-Code." />
            <min value="0" />
            <max value="1" />
            <patternCoding>
                <system value="http://snomed.info/sct" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-allergy-intolerance-reaction-snomed-ct-vs" />
            </binding>
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding:snomed.system">
            <path value="AllergyIntolerance.reaction.manifestation.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding:snomed.version">
            <path value="AllergyIntolerance.reaction.manifestation.coding.version" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding:snomed.code">
            <path value="AllergyIntolerance.reaction.manifestation.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding:snomed.display">
            <path value="AllergyIntolerance.reaction.manifestation.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.text">
            <path value="AllergyIntolerance.reaction.manifestation.text" />
            <definition value="Bezeichnung bzw. Beschreibung der Manifestation als Freitext." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.description">
            <path value="AllergyIntolerance.reaction.description" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.onset">
            <path value="AllergyIntolerance.reaction.onset" />
            <definition value="Datum eines Reaktionsereignisses." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.severity">
            <path value="AllergyIntolerance.reaction.severity" />
            <definition value="Dieses Element enth&#228;lt Informationen zum Schweregrad der Reaktion." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute">
            <path value="AllergyIntolerance.reaction.exposureRoute" />
            <definition value="Hier kann der Expositionsweg des Allergens angegeben werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <definition value="Hier kann der Expositionsweg als codierte Information angegeben werden." />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:snomed">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding" />
            <sliceName value="snomed" />
            <definition value="SNOMED CT&#174;-Code f&#252;r die Bezeichnung des Expositionswegs." />
            <min value="0" />
            <max value="1" />
            <patternCoding>
                <system value="http://snomed.info/sct" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-route-of-administration-snomed-ct-vs" />
            </binding>
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:snomed.system">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:snomed.version">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.version" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:snomed.code">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:snomed.display">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:edqmCode">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding" />
            <sliceName value="edqmCode" />
            <definition value="EDQM-Code f&#252;r die Bezeichnung des Expositionswegs." />
            <min value="0" />
            <max value="1" />
            <patternCoding>
                <system value="http://standardterms.edqm.eu" />
            </patternCoding>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medicine-route-of-administration-edqm-vs" />
            </binding>
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.system">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.code">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.display">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.text">
            <path value="AllergyIntolerance.reaction.exposureRoute.text" />
            <definition value="Hier kann der Expositionsweg als Freitext angegeben werden." />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-allergy-intolerance",
    "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance",
    "version": "1.1.0",
    "name": "EPAAllergyIntolerance",
    "title": "EPA Allergy Intolerance Profile",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "mio42 GmbH",
    "description": "Dieses Profil bildet eine Allergie oder Unverträglichkeit ab.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "AllergyIntolerance",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "AllergyIntolerance",
                "path": "AllergyIntolerance",
                "definition": "Dieses Profil bildet eine Allergie oder Unverträglichkeit ab."
            },
            {
                "id": "AllergyIntolerance.meta",
                "path": "AllergyIntolerance.meta",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.meta.versionId",
                "path": "AllergyIntolerance.meta.versionId",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.meta.lastUpdated",
                "path": "AllergyIntolerance.meta.lastUpdated",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.text",
                "path": "AllergyIntolerance.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": "AllergyIntolerance.text.status",
                "path": "AllergyIntolerance.text.status",
                "fixedCode": "extensions"
            },
            {
                "id": "AllergyIntolerance.extension",
                "path": "AllergyIntolerance.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "description": "Extensions are always sliced by (at least) url",
                    "rules": "open",
                    "ordered": false
                },
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.extension:abatement",
                "path": "AllergyIntolerance.extension",
                "sliceName": "abatement",
                "short": "Klinisch relevantes Enddatum",
                "definition": "In diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unverträglichkeit hatte.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance-abatement-extension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.extension:abatement-phase-until",
                "path": "AllergyIntolerance.extension",
                "sliceName": "abatement-phase-until",
                "short": "abatement-lebensphase-bis",
                "definition": "Angabe des ungefähren Alters, ab dem der/die Patient:in die Allergie/Unverträglichkeit nicht mehr hat.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://gematik.de/fhir/epa/StructureDefinition/epa-stage-life-extension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus",
                "path": "AllergyIntolerance.clinicalStatus",
                "definition": "Beschreibt den Status einer Allergie bzw. Unverträglichkeit aus klinischer Sicht.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding",
                "path": "AllergyIntolerance.clinicalStatus.coding",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.system",
                "path": "AllergyIntolerance.clinicalStatus.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.version",
                "path": "AllergyIntolerance.clinicalStatus.coding.version",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.code",
                "path": "AllergyIntolerance.clinicalStatus.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.display",
                "path": "AllergyIntolerance.clinicalStatus.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus",
                "path": "AllergyIntolerance.verificationStatus",
                "definition": "Gibt den Grad der Sicherheit oder Gewissheit an, mit der das tatsächliche Vorliegen der Allergie/Unverträglichkeit angegeben werden kann.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding",
                "path": "AllergyIntolerance.verificationStatus.coding",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.system",
                "path": "AllergyIntolerance.verificationStatus.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.version",
                "path": "AllergyIntolerance.verificationStatus.coding.version",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.code",
                "path": "AllergyIntolerance.verificationStatus.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.display",
                "path": "AllergyIntolerance.verificationStatus.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.type",
                "path": "AllergyIntolerance.type",
                "definition": "In diesem Element kann angegeben werden, ob es sich um eine Allergie oder eine Unverträglichkeit handelt",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.category",
                "path": "AllergyIntolerance.category",
                "definition": "Enthält die Kategorie der die Allergie oder Unverträglichkeit auslösenden Substanz gemäß den angegebenen Auswahlmöglichkeiten.",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.criticality",
                "path": "AllergyIntolerance.criticality",
                "definition": "Beschreibt die Kritikalität. Die Kritikalität gibt an, wie hoch Risiko dafür ist, dass die Exposition zu der Substanz eine schwerwiegende oder lebensbedrohliche Situation hervorruft.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code",
                "path": "AllergyIntolerance.code",
                "definition": "Dieses Element bildet die Substanz bzw. Substanzgruppen ab, gegen die eine Allergie oder Unverträglichkeit besteht. Diese kann als codierte Information und/oder als Freitext angegeben werden.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding",
                "path": "AllergyIntolerance.code.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "definition": "Hier kann die Substanz als codierte Information angegeben werden.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:snomed",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "snomed",
                "definition": "Hier kann ein SNOMED CT®-Code für die Substanz angegeben werden.",
                "min": 0,
                "max": "1",
                "patternCoding": {
                    "system": "http://snomed.info/sct"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs"
                }
            },
            {
                "id": "AllergyIntolerance.code.coding:snomed.system",
                "path": "AllergyIntolerance.code.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:snomed.version",
                "path": "AllergyIntolerance.code.coding.version",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:snomed.code",
                "path": "AllergyIntolerance.code.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:snomed.display",
                "path": "AllergyIntolerance.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:ask",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "ask",
                "definition": "Hier kann ein ASK-Code für die Substanz angegeben werden.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Coding",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/CodingASK"
                        ]
                    }
                ],
                "patternCoding": {
                    "system": "http://fhir.de/CodeSystem/ask"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.de/ValueSet/ask"
                }
            },
            {
                "id": "AllergyIntolerance.code.coding:ask.system",
                "path": "AllergyIntolerance.code.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:ask.code",
                "path": "AllergyIntolerance.code.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:ask.display",
                "path": "AllergyIntolerance.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:atc-de",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "atc-de",
                "definition": "Hier kann ein deutscher ATC-Code für die Substanz angegeben werden.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Coding",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/CodingATC"
                        ]
                    }
                ],
                "patternCoding": {
                    "system": "http://fhir.de/CodeSystem/bfarm/atc"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.de/ValueSet/bfarm/atc"
                }
            },
            {
                "id": "AllergyIntolerance.code.coding:atc-de.system",
                "path": "AllergyIntolerance.code.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:atc-de.version",
                "path": "AllergyIntolerance.code.coding.version",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:atc-de.code",
                "path": "AllergyIntolerance.code.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.coding:atc-de.display",
                "path": "AllergyIntolerance.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.code.text",
                "path": "AllergyIntolerance.code.text",
                "definition": "Hier kann die Bezeichnung der Substanz als Freitext angegeben werden.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.patient",
                "path": "AllergyIntolerance.patient",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.patient.identifier",
                "path": "AllergyIntolerance.patient.identifier",
                "min": 1,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-kvid-10"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]",
                "path": "AllergyIntolerance.onset[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                },
                "definition": "In diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unverträglichkeit hatte bzw. hat.",
                "type":  [
                    {
                        "code": "dateTime"
                    },
                    {
                        "code": "Age"
                    },
                    {
                        "code": "Period"
                    }
                ]
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetDateTime",
                "path": "AllergyIntolerance.onset[x]",
                "sliceName": "onsetDateTime",
                "short": "Klinischer Zeitraum datiert \"von\"",
                "definition": "Datum, ab wann die Allergie/Unverträglichkeit identifiziert wurde.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetAge",
                "path": "AllergyIntolerance.onset[x]",
                "sliceName": "onsetAge",
                "short": "Klinischer Zeitraum",
                "definition": "Angabe der Lebensphasen, in denen die Allergie/Unverträglichkeit begonnen hat.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Age"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetAge.extension",
                "path": "AllergyIntolerance.onset[x].extension",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetAge.extension:phase-from",
                "path": "AllergyIntolerance.onset[x].extension",
                "sliceName": "phase-from",
                "short": "lebensphase-von",
                "definition": "Angabe des ungefähren Alters, ab dem der/die Patient:in die Allergie/Unverträglichkeit hat.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://gematik.de/fhir/epa/StructureDefinition/epa-stage-life-extension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetPeriod",
                "path": "AllergyIntolerance.onset[x]",
                "sliceName": "onsetPeriod",
                "definition": "Klinisch relevanter Zeitraum als Zeitintervall mit Datumsangaben, ab/bis wann der/die Patient:in die Allergie/Unverträglichkeit hatte bzw. hat.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Period"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetPeriod.start",
                "path": "AllergyIntolerance.onset[x].start",
                "definition": "Datum, ab wann die Allergie/Unverträglichkeit identifiziert wurde.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.onset[x]:onsetPeriod.end",
                "path": "AllergyIntolerance.onset[x].end",
                "definition": "Datum, bis wann der/die Patient:in die Allergie/Unverträglichkeit hatte.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recorder",
                "path": "AllergyIntolerance.recorder",
                "definition": "Hier wird die Aufzeichnende Person der \"Allergie/Unverträglichkeit\" referenziert.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
                            "http://hl7.org/fhir/StructureDefinition/Practitioner",
                            "http://hl7.org/fhir/StructureDefinition/PractitionerRole"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recorder.reference",
                "path": "AllergyIntolerance.recorder.reference",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.recorder.identifier",
                "path": "AllergyIntolerance.recorder.identifier",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-kvid-10",
                            "http://fhir.de/StructureDefinition/identifier-telematik-id"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.asserter",
                "path": "AllergyIntolerance.asserter",
                "definition": "Hier wird die Quelle der Information der \"Allergie/Unverträglichkeit\" abgebildet.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.asserter.reference",
                "path": "AllergyIntolerance.asserter.reference",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.asserter.identifier",
                "path": "AllergyIntolerance.asserter.identifier",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-kvid-10",
                            "http://fhir.de/StructureDefinition/identifier-telematik-id"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note",
                "path": "AllergyIntolerance.note",
                "definition": "Hier können ergänzende Informationen zur Allergie bzw. Unverträglichkeit angegeben werden. ",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note.author[x]",
                "path": "AllergyIntolerance.note.author[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "rules": "closed"
                },
                "definition": "Hier wird die Person/Einrichtung referenziert, die die Notiz erstellt hat.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Practitioner",
                            "http://hl7.org/fhir/StructureDefinition/Patient",
                            "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
                            "http://hl7.org/fhir/StructureDefinition/Organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note.author[x]:authorReference",
                "path": "AllergyIntolerance.note.author[x]",
                "sliceName": "authorReference",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Organization",
                            "http://hl7.org/fhir/StructureDefinition/Patient",
                            "http://hl7.org/fhir/StructureDefinition/Practitioner"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note.author[x]:authorReference.reference",
                "path": "AllergyIntolerance.note.author[x].reference",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note.author[x]:authorReference.identifier",
                "path": "AllergyIntolerance.note.author[x].identifier",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-kvid-10",
                            "http://fhir.de/StructureDefinition/identifier-telematik-id"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note.time",
                "path": "AllergyIntolerance.note.time",
                "definition": "Hier wird der Zeitpunkt angegeben, zu dem die Notiz erstellt wurde.",
                "comment": "Dieses Element sollte in der Regel automatisiert ohne Aufwand für die Person, die die Notiz erstellt befüllt werden.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.note.text",
                "path": "AllergyIntolerance.note.text",
                "definition": "Hier wird der eigentliche Text der Notiz eingetragen.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction",
                "path": "AllergyIntolerance.reaction",
                "definition": "Dieses Element enthält Informationen über die Reaktion, die bei diesem/dieser Patient:in nach Exposition hervorgerufen wird.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance",
                "path": "AllergyIntolerance.reaction.substance",
                "definition": "Dieses Element bildet die spezifische Substanz ab, welche die Reaktion hervorruft.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "definition": "Dieses Element bildet die Substanz als codierte Information ab.",
                "comment": "Das MustSupport gilt nur für die vordefinierten Slices.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:snomed",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "sliceName": "snomed",
                "definition": "Hier kann ein SNOMED CT®-Code für die Substanz angegeben werden.",
                "min": 0,
                "max": "1",
                "patternCoding": {
                    "system": "http://snomed.info/sct"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs"
                }
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:snomed.system",
                "path": "AllergyIntolerance.reaction.substance.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:snomed.version",
                "path": "AllergyIntolerance.reaction.substance.coding.version",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:snomed.code",
                "path": "AllergyIntolerance.reaction.substance.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:snomed.display",
                "path": "AllergyIntolerance.reaction.substance.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:ask",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "sliceName": "ask",
                "definition": "Hier kann ein ASK-Code für die Substanz angegeben werden.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Coding",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/CodingASK"
                        ]
                    }
                ],
                "patternCoding": {
                    "system": "http://fhir.de/CodeSystem/ask"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.de/ValueSet/ask"
                }
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:ask.system",
                "path": "AllergyIntolerance.reaction.substance.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:ask.code",
                "path": "AllergyIntolerance.reaction.substance.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:ask.display",
                "path": "AllergyIntolerance.reaction.substance.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:atc-de",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "sliceName": "atc-de",
                "definition": "Hier kann ein deutscher ATC-Code für die Substanz angegeben werden.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Coding",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/CodingATC"
                        ]
                    }
                ],
                "patternCoding": {
                    "system": "http://fhir.de/CodeSystem/bfarm/atc"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.de/ValueSet/bfarm/atc"
                }
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:atc-de.system",
                "path": "AllergyIntolerance.reaction.substance.coding.system",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:atc-de.version",
                "path": "AllergyIntolerance.reaction.substance.coding.version",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:atc-de.code",
                "path": "AllergyIntolerance.reaction.substance.coding.code",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:atc-de.display",
                "path": "AllergyIntolerance.reaction.substance.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.substance.text",
                "path": "AllergyIntolerance.reaction.substance.text",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation",
                "path": "AllergyIntolerance.reaction.manifestation",
                "definition": "In diesem Element können Angaben zur Manifestation der Reaktion gemacht werden.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding",
                "path": "AllergyIntolerance.reaction.manifestation.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "definition": "Hier kann die Manifestation als codierte Information angegeben werden.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding:snomed",
                "path": "AllergyIntolerance.reaction.manifestation.coding",
                "sliceName": "snomed",
                "definition": "Manifestation als SNOMED CT®-Code.",
                "min": 0,
                "max": "1",
                "patternCoding": {
                    "system": "http://snomed.info/sct"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-allergy-intolerance-reaction-snomed-ct-vs"
                }
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding:snomed.system",
                "path": "AllergyIntolerance.reaction.manifestation.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding:snomed.version",
                "path": "AllergyIntolerance.reaction.manifestation.coding.version",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding:snomed.code",
                "path": "AllergyIntolerance.reaction.manifestation.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding:snomed.display",
                "path": "AllergyIntolerance.reaction.manifestation.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.text",
                "path": "AllergyIntolerance.reaction.manifestation.text",
                "definition": "Bezeichnung bzw. Beschreibung der Manifestation als Freitext.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.description",
                "path": "AllergyIntolerance.reaction.description",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.onset",
                "path": "AllergyIntolerance.reaction.onset",
                "definition": "Datum eines Reaktionsereignisses.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.severity",
                "path": "AllergyIntolerance.reaction.severity",
                "definition": "Dieses Element enthält Informationen zum Schweregrad der Reaktion.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute",
                "path": "AllergyIntolerance.reaction.exposureRoute",
                "definition": "Hier kann der Expositionsweg des Allergens angegeben werden.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "open"
                },
                "definition": "Hier kann der Expositionsweg als codierte Information angegeben werden.",
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:snomed",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding",
                "sliceName": "snomed",
                "definition": "SNOMED CT®-Code für die Bezeichnung des Expositionswegs.",
                "min": 0,
                "max": "1",
                "patternCoding": {
                    "system": "http://snomed.info/sct"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-route-of-administration-snomed-ct-vs"
                }
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:snomed.system",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:snomed.version",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.version",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:snomed.code",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:snomed.display",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:edqmCode",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding",
                "sliceName": "edqmCode",
                "definition": "EDQM-Code für die Bezeichnung des Expositionswegs.",
                "min": 0,
                "max": "1",
                "patternCoding": {
                    "system": "http://standardterms.edqm.eu"
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medicine-route-of-administration-edqm-vs"
                }
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.system",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.code",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.display",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.text",
                "path": "AllergyIntolerance.reaction.exposureRoute.text",
                "definition": "Hier kann der Expositionsweg als Freitext angegeben werden.",
                "mustSupport": true
            }
        ]
    }
}


Profil für die Datenverwaltung im Kontext der Medikationsplanung

EPA Allergy Intolerance AMTSrZI

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdS Σ0..1id
lastUpdatedS Σ0..1instant
sourceΣ0..0uri
profileΣ0..*canonical(StructureDefinition)
securityΣ0..0CodingBinding
tagΣ0..0Coding
implicitRulesΣ ?!0..0uri
language0..0codeBinding
contained0..0Resource
abatementS I0..1Extension(dateTime)
abatement-phase-untilS I0..1Extension(CodeableConcept)
modifierExtension?! I0..0Extension
identifierΣ0..0Identifier
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textΣ0..0string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textΣ0..0string
typeS Σ0..1codeBinding
categoryS Σ0..1codeBinding
criticalityS Σ0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionΣ0..0string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textS Σ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
identifierS Σ1..1IdentifierKvid10
displayΣ0..0string
encounterI0..0Reference(Encounter)
onsetDateTimeS0..1dateTime
id0..1string
phase-fromS I0..1Extension(CodeableConcept)
valueΣ0..1decimal
comparatorΣ ?!0..1codeBinding
unitΣ0..1string
systemΣ I0..1uri
codeΣ0..1code
id0..1string
extensionI0..*Extension
startS Σ I0..1dateTime
endS Σ I0..1dateTime
recordedDate0..0dateTime
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..0uriBinding
identifierS Σ0..1IdentifierKvid10, IdentifierTelematikId
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..0uriBinding
identifierS Σ0..1IdentifierKvid10, IdentifierTelematikId
displayΣ0..0string
lastOccurrence0..0dateTime
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..0uriBinding
identifierS Σ0..1IdentifierKvid10, IdentifierTelematikId
displayΣ0..0string
timeS Σ0..1dateTime
textS Σ1..1markdown
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionΣ0..0string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed ValuePattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textS Σ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textS Σ0..1string
descriptionS0..1string
onsetS0..1dateTime
severityS0..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionS Σ1..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
id0..1string
extensionI0..*Extension
systemS Σ1..1uriPattern
versionΣ0..0string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..0boolean
textS Σ0..1string
note0..0Annotation
AllergyIntolerance
DefinitionDieses Profil bildet eine Allergie oder Unverträglichkeit ab.
Cardinality0...*
AliasAllergy, Intolerance, Adverse Reaction
Comments

Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

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()
  • ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
  • ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
Mappings
  • rim: Entity. Role, or Act
  • rim: Observation[classCode=OBS, moodCode=EVN]
AllergyIntolerance.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.

AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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...0
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
AllergyIntolerance.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
AllergyIntolerance.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...0
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
AllergyIntolerance.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...0
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
AllergyIntolerance.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...0
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
AllergyIntolerance.language
DefinitionThe base language in which the resource is written.
Cardinality0...0
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
AllergyIntolerance.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...0
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?
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.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...0
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
AllergyIntolerance.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...2
TypeExtension
Must SupportTrue
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, Closed, 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
AllergyIntolerance.extension:abatement
DefinitionIn diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unverträglichkeit hatte.
Cardinality0...1
TypeExtension(dateTime)
Must SupportTrue
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.

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
AllergyIntolerance.extension:abatement-phase-until
DefinitionAngabe des ungefähren Alters, ab dem der/die Patient:in die Allergie/Unverträglichkeit nicht mehr hat.
Cardinality0...1
TypeExtension(CodeableConcept)
Must SupportTrue
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.

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
AllergyIntolerance.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...0
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
AllergyIntolerance.identifier
DefinitionBusiness identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Cardinality0...0
TypeIdentifier
SummaryTrue
Requirements

Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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
  • v2: IAM-7
  • rim: id
AllergyIntolerance.clinicalStatus
DefinitionBeschreibt den Status einer Allergie bzw. Unverträglichkeit aus klinischer Sicht.
Cardinality0...1
TypeCodeableConcept
Binding

The clinical status of the allergy or intolerance.

AllergyIntoleranceClinicalStatusCodes (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

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.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...*
TypeCoding
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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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
AllergyIntolerance.clinicalStatus.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...0
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 ]
AllergyIntolerance.clinicalStatus.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...0
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
AllergyIntolerance.verificationStatus
DefinitionGibt den Grad der Sicherheit oder Gewissheit an, mit der das tatsächliche Vorliegen der Allergie/Unverträglichkeit angegeben werden kann.
Cardinality0...1
TypeCodeableConcept
Binding

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

AllergyIntoleranceVerificationStatusCodes (required)
Must SupportTrue
ModifierTrue
SummaryTrue
Comments

The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.

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.status
  • rim: Observation ACT .inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...*
TypeCoding
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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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
AllergyIntolerance.verificationStatus.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...0
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 ]
AllergyIntolerance.verificationStatus.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...0
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
AllergyIntolerance.type
DefinitionIn diesem Element kann angegeben werden, ob es sich um eine Allergie oder eine Unverträglichkeit handelt
Cardinality0...1
Typecode
Binding

Identification of the underlying physiological mechanism for a Reaction Risk.

AllergyIntoleranceType (required)
Must SupportTrue
SummaryTrue
AliasCategory, Class
Comments

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • v2: IAM-9
  • rim: code
AllergyIntolerance.category
DefinitionEnthält die Kategorie der die Allergie oder Unverträglichkeit auslösenden Substanz gemäß den angegebenen Auswahlmöglichkeiten.
Cardinality0...1
Typecode
Binding

Category of an identified substance associated with allergies or intolerances.

AllergyIntoleranceCategory (required)
Must SupportTrue
SummaryTrue
AliasCategory, Type, Reaction Type, Class
Comments

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • v2: AL1-2
  • rim: value < IntoleranceValue (Agent)
AllergyIntolerance.criticality
DefinitionBeschreibt die Kritikalität. Die Kritikalität gibt an, wie hoch Risiko dafür ist, dass die Exposition zu der Substanz eine schwerwiegende oder lebensbedrohliche Situation hervorruft.
Cardinality0...1
Typecode
Binding

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

AllergyIntoleranceCriticality (required)
Must SupportTrue
SummaryTrue
AliasSeverity, Seriousness, Contra-indication, Risk
Comments

The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.grade
  • v2: AL1-4
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
AllergyIntolerance.code
DefinitionDieses Element bildet die Substanz bzw. Substanzgruppen ab, gegen die eine Allergie oder Unverträglichkeit besteht. Diese kann als codierte Information und/oder als Freitext angegeben werden.
Cardinality1...1
TypeCodeableConcept
Binding

Type of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies.

AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example)
Must SupportTrue
SummaryTrue
AliasCode
Comments

It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship.

The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.

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]
  • v2: AL1-3 / IAM-3
  • rim: substance/product: .participation[typeCode=CAGNT].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] negated/excluded substance/product: .participation[typeCode=CAGNT, negationInd=true].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType] positive or negated/excluded condition/situation: Observation.code=ASSERTION; Observation.value
AllergyIntolerance.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
AllergyIntolerance.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
AllergyIntolerance.code.coding
DefinitionHier kann die Substanz als codierte Information angegeben werden.
Cardinality0...3
TypeCoding
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.

SlicingUnordered, Closed, by $this(Value)
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
AllergyIntolerance.code.coding:snomed
DefinitionHier kann ein SNOMED CT®-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCoding
BindingEPASubstanceSNOMEDCTVS (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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.code.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.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
AllergyIntolerance.code.coding:snomed.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.code.coding:ask
DefinitionHier kann ein ASK-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingASK
BindingASK (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.

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

{
  "system": "http://fhir.de/CodeSystem/ask"
}

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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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())
Fixed Value

http://fhir.de/CodeSystem/ask

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.code.coding:ask.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...0
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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.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
AllergyIntolerance.code.coding:ask.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.code.coding:atc-de
DefinitionHier kann ein deutscher ATC-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingATC
BindingATC (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.

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

{
  "system": "http://fhir.de/CodeSystem/bfarm/atc"
}

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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.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())
Fixed Value

http://fhir.de/CodeSystem/bfarm/atc

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.code.coding:atc-de.version
DefinitionBie Verwendung von ATC ist die Angabe der Version zwingend erforderlich. Hierdurch wird der Tatsache Rechnung getragen, dass jede der jährlich neu erscheinenden Fassung von ATC ein neues Codesystem darstellt.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.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
AllergyIntolerance.code.coding:atc-de.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.code.text
DefinitionHier kann die Bezeichnung der Substanz als Freitext angegeben werden.
Cardinality0...1
Typestring
Must SupportTrue
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
AllergyIntolerance.patient
DefinitionThe patient who has the allergy or intolerance.
Cardinality1...1
TypeReference(Patient)
Must SupportTrue
SummaryTrue
AliasPatient
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.subject[x]
  • v2: (PID-3)
  • rim: .participation[typeCode=SBJ].role[classCode=PAT]
  • w5: FiveWs.subject
AllergyIntolerance.patient.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
AllergyIntolerance.patient.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
AllergyIntolerance.patient.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...0
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
AllergyIntolerance.patient.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...0
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
AllergyIntolerance.patient.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
AllergyIntolerance.patient.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
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
AllergyIntolerance.encounter
DefinitionThe encounter when the allergy or intolerance was asserted.
Cardinality0...0
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]
AllergyIntolerance.onset[x]
DefinitionIn diesem Element kann angegeben werden, in welchem Zeitraum bzw. ab wann der/die Patient:in die Allergie/Unverträglichkeit hatte bzw. hat.
Cardinality0...1
TypedateTime
SlicingUnordered, Open, by $this(Type)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetDateTime
DefinitionDatum, ab wann die Allergie/Unverträglichkeit identifiziert wurde.
Cardinality0...1
TypedateTime
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetAge
DefinitionAngabe der Lebensphasen, in denen die Allergie/Unverträglichkeit begonnen hat.
Cardinality0...1
TypeAge
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetAge.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
AllergyIntolerance.onset[x]:onsetAge.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
Must SupportTrue
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
AllergyIntolerance.onset[x]:onsetAge.extension:phase-from
DefinitionAngabe des ungefähren Alters, ab dem der/die Patient:in die Allergie/Unverträglichkeit hat.
Cardinality0...1
TypeExtension(CodeableConcept)
Must SupportTrue
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.

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
AllergyIntolerance.onset[x]:onsetAge.value
DefinitionThe value of the measured amount. The value includes an implicit precision in the presentation of the value.
Cardinality0...1
Typedecimal
SummaryTrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SN.2 / CQ - N/A
  • rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
AllergyIntolerance.onset[x]:onsetAge.comparator
DefinitionHow the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Cardinality0...1
Typecode
Binding

How the Quantity should be understood and represented.

QuantityComparator (required)
ModifierTrue
SummaryTrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

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: SN.1 / CQ.1
  • rim: IVL properties
AllergyIntolerance.onset[x]:onsetAge.unit
DefinitionA human-readable form of the unit.
Cardinality0...1
Typestring
SummaryTrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

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: (see OBX.6 etc.) / CQ.2
  • rim: PQ.unit
AllergyIntolerance.onset[x]:onsetAge.system
DefinitionThe identification of the system that provides the coded form of the unit.
Cardinality0...1
Typeuri
SummaryTrue
Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: CO.codeSystem, PQ.translation.codeSystem
AllergyIntolerance.onset[x]:onsetAge.code
DefinitionA computer processable form of the unit in some unit representation system.
Cardinality0...1
Typecode
SummaryTrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.code, MO.currency, PQ.translation.code
AllergyIntolerance.onset[x]:onsetPeriod
DefinitionKlinisch relevanter Zeitraum als Zeitintervall mit Datumsangaben, ab/bis wann der/die Patient:in die Allergie/Unverträglichkeit hatte bzw. hat.
Cardinality0...1
TypePeriod
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.init
  • rim: effectiveTime.low
AllergyIntolerance.onset[x]:onsetPeriod.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
AllergyIntolerance.onset[x]:onsetPeriod.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
AllergyIntolerance.onset[x]:onsetPeriod.start
DefinitionDatum, ab wann die Allergie/Unverträglichkeit identifiziert wurde.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: DR.1
  • rim: ./low
AllergyIntolerance.onset[x]:onsetPeriod.end
DefinitionDatum, bis wann der/die Patient:in die Allergie/Unverträglichkeit hatte.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: DR.2
  • rim: ./high
AllergyIntolerance.recordedDate
DefinitionThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
Cardinality0...0
TypedateTime
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
  • v2: IAM-13
  • rim: .participation[typeCode=AUT].time
AllergyIntolerance.recorder
DefinitionHier wird die Aufzeichnende Person der "Allergie/Unverträglichkeit" referenziert.
Cardinality0...1
TypeReference(RelatedPerson | Practitioner | PractitionerRole)
Must SupportTrue
AliasAuthor
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.author
  • rim: .participation[typeCode=AUT].role
AllergyIntolerance.recorder.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
AllergyIntolerance.recorder.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
AllergyIntolerance.recorder.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
Must SupportTrue
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
AllergyIntolerance.recorder.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...0
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
AllergyIntolerance.recorder.identifier
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.
Cardinality0...1
TypeIdentifierKvid10, IdentifierTelematikId
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
AllergyIntolerance.recorder.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
AllergyIntolerance.asserter
DefinitionHier wird die Quelle der Information der "Allergie/Unverträglichkeit" abgebildet.
Cardinality0...1
TypeReference(Patient | RelatedPerson | Practitioner | PractitionerRole)
Must SupportTrue
SummaryTrue
AliasSource, Informant
Comments

The recorder takes responsibility for the content, but can reference the source from where they got it.

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.source
  • v2: IAM-14 (if patient) / IAM-18 (if practitioner)
  • rim: .participation[typeCode=INF].role
AllergyIntolerance.asserter.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
AllergyIntolerance.asserter.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
AllergyIntolerance.asserter.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
Must SupportTrue
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
AllergyIntolerance.asserter.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...0
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
AllergyIntolerance.asserter.identifier
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.
Cardinality0...1
TypeIdentifierKvid10, IdentifierTelematikId
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
AllergyIntolerance.asserter.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
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
AllergyIntolerance.lastOccurrence
DefinitionRepresents the date and/or time of the last known occurrence of a reaction event.
Cardinality0...0
TypedateTime
Comments

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

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=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)].effectiveTime
AllergyIntolerance.note
DefinitionHier können ergänzende Informationen zur Allergie bzw. Unverträglichkeit angegeben werden.
Cardinality0...*
TypeAnnotation
Must SupportTrue
Comments

For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

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: subjectOf.observationEvent[code="annotation"].value
AllergyIntolerance.note.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
AllergyIntolerance.note.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
AllergyIntolerance.note.author[x]
DefinitionHier wird die Person/Einrichtung referenziert, die die Notiz erstellt hat.
Cardinality0...1
TypeReference(Practitioner | Patient | RelatedPerson | Organization)
Must SupportTrue
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

SlicingUnordered, Closed, by $this(Type)
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.participant[typeCode=AUT].role
AllergyIntolerance.note.author[x]:authorReference
DefinitionThe individual responsible for making the annotation.
Cardinality0...1
TypeReference(Organization | Patient | Practitioner)
Must SupportTrue
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

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.participant[typeCode=AUT].role
AllergyIntolerance.note.author[x]:authorReference.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
AllergyIntolerance.note.author[x]:authorReference.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
AllergyIntolerance.note.author[x]:authorReference.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
Must SupportTrue
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
AllergyIntolerance.note.author[x]:authorReference.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...0
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
AllergyIntolerance.note.author[x]:authorReference.identifier
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.
Cardinality0...1
TypeIdentifierKvid10, IdentifierTelematikId
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
AllergyIntolerance.note.author[x]:authorReference.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
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
AllergyIntolerance.note.time
DefinitionHier wird der Zeitpunkt angegeben, zu dem die Notiz erstellt wurde.
Cardinality0...1
TypedateTime
Must SupportTrue
SummaryTrue
Comments

Dieses Element sollte in der Regel automatisiert ohne Aufwand für die Person, die die Notiz erstellt befüllt werden.

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.effectiveTime
AllergyIntolerance.note.text
DefinitionHier wird der eigentliche Text der Notiz eingetragen.
Cardinality1...1
Typemarkdown
Must SupportTrue
SummaryTrue
Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

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.text
AllergyIntolerance.reaction
DefinitionDieses Element enthält Informationen über die Reaktion, die bei diesem/dieser Patient:in nach Exposition hervorgerufen wird.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
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=SUBJ].target[classCode=OBS, moodCode=EVN, code <= CommonClinicalObservationType, value <= ObservationValue (Reaction Type)]
AllergyIntolerance.reaction.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
AllergyIntolerance.reaction.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
AllergyIntolerance.reaction.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
AllergyIntolerance.reaction.substance
DefinitionDieses Element bildet die spezifische Substanz ab, welche die Reaktion hervorruft.
Cardinality0...1
TypeCodeableConcept
Binding

Codes defining the type of the substance (including pharmaceutical products).

SubstanceCode (example)
Must SupportTrue
Comments

Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in '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
  • rim: outBoundRelationship[typeCode=SAS].target[classCode=SBADM, code <= ExposureCode].participation[typeCode=CSM].role[classCode=ADMM].player[classCode=MAT, determinerCode=KIND, code <= ExposureAgentEntityType]
AllergyIntolerance.reaction.substance.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
AllergyIntolerance.reaction.substance.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
AllergyIntolerance.reaction.substance.coding
DefinitionDieses Element bildet die Substanz als codierte Information ab.
Cardinality0...3
TypeCoding
Must SupportTrue
SummaryTrue
Requirements

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

Comments

Das MustSupport gilt nur für die vordefinierten Slices.

SlicingUnordered, Closed, by $this(Value)
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
AllergyIntolerance.reaction.substance.coding:snomed
DefinitionHier kann ein SNOMED CT®-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCoding
BindingEPASubstanceSNOMEDCTVS (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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.substance.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.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
AllergyIntolerance.reaction.substance.coding:snomed.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.reaction.substance.coding:ask
DefinitionHier kann ein ASK-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingASK
BindingASK (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.

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

{
  "system": "http://fhir.de/CodeSystem/ask"
}

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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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())
Fixed Value

http://fhir.de/CodeSystem/ask

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.substance.coding:ask.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...0
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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.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
AllergyIntolerance.reaction.substance.coding:ask.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.reaction.substance.coding:atc-de
DefinitionHier kann ein deutscher ATC-Code für die Substanz angegeben werden.
Cardinality0...1
TypeCodingATC
BindingATC (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.

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

{
  "system": "http://fhir.de/CodeSystem/bfarm/atc"
}

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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.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())
Fixed Value

http://fhir.de/CodeSystem/bfarm/atc

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.substance.coding:atc-de.version
DefinitionBie Verwendung von ATC ist die Angabe der Version zwingend erforderlich. Hierdurch wird der Tatsache Rechnung getragen, dass jede der jährlich neu erscheinenden Fassung von ATC ein neues Codesystem darstellt.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.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
AllergyIntolerance.reaction.substance.coding:atc-de.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.reaction.substance.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
Must SupportTrue
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
AllergyIntolerance.reaction.manifestation
DefinitionIn diesem Element können Angaben zur Manifestation der Reaktion gemacht werden.
Cardinality1...*
TypeCodeableConcept
Binding

Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.

SNOMEDCTClinicalFindings (example)
Must SupportTrue
AliasSymptoms, Signs
Comments

Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.

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
  • v2: AL1-5
  • rim: code
AllergyIntolerance.reaction.manifestation.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
AllergyIntolerance.reaction.manifestation.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
AllergyIntolerance.reaction.manifestation.coding
DefinitionHier kann die Manifestation als codierte Information angegeben werden.
Cardinality0...1
TypeCoding
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.

SlicingUnordered, Closed, by $this(Value)
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
AllergyIntolerance.reaction.manifestation.coding:snomed
DefinitionManifestation als SNOMED CT®-Code.
Cardinality0...1
TypeCoding
BindingEPAAllergyIntoleranceReactionSNOMEDCTVS (extensible)
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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.manifestation.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.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
AllergyIntolerance.reaction.manifestation.coding:snomed.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.reaction.manifestation.text
DefinitionBezeichnung bzw. Beschreibung der Manifestation als Freitext.
Cardinality0...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.description
DefinitionText description about the reaction as a whole, including details of the manifestation if required.
Cardinality0...1
Typestring
Must SupportTrue
AliasNarrative, Text
Comments

Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: text
AllergyIntolerance.reaction.onset
DefinitionDatum eines Reaktionsereignisses.
Cardinality0...1
TypedateTime
Must SupportTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: AL1-6
  • rim: effectiveTime.low
AllergyIntolerance.reaction.severity
DefinitionDieses Element enthält Informationen zum Schweregrad der Reaktion.
Cardinality0...1
Typecode
Binding

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

AllergyIntoleranceSeverity (required)
Must SupportTrue
Comments

It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV, value <= SeverityObservation (Severity Level)]
AllergyIntolerance.reaction.exposureRoute
DefinitionHier kann der Expositionsweg des Allergens angegeben werden.
Cardinality0...1
TypeCodeableConcept
Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

SNOMEDCTRouteCodes (example)
Must SupportTrue
Comments

Coding of the route of exposure with a terminology should be used wherever possible.

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=SAS].target[classCode=SBADM, code <= ExposureCode].routeCode
AllergyIntolerance.reaction.exposureRoute.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
AllergyIntolerance.reaction.exposureRoute.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
AllergyIntolerance.reaction.exposureRoute.coding
DefinitionHier kann der Expositionsweg als codierte Information angegeben werden.
Cardinality0...2
TypeCoding
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.

SlicingUnordered, Closed, by $this(Value)
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
AllergyIntolerance.reaction.exposureRoute.coding:snomed
DefinitionSNOMED CT®-Code für die Bezeichnung des Expositionswegs.
Cardinality0...1
TypeCoding
BindingEPARouteOfAdministrationSNOMEDCTVS (extensible)
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())
Pattern

{
  "system": "http://snomed.info/sct"
}

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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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())
Pattern

http://snomed.info/sct

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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.
Cardinality1...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.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
AllergyIntolerance.reaction.exposureRoute.coding:snomed.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode
DefinitionEDQM-Code für die Bezeichnung des Expositionswegs.
Cardinality0...1
TypeCoding
BindingEPAMedicineRouteOfAdministrationEDQMVS (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())
Pattern

{
  "system": "http://standardterms.edqm.eu"
}

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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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())
Pattern

http://standardterms.edqm.eu

Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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...0
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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.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
AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
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 ]
AllergyIntolerance.reaction.exposureRoute.text
DefinitionHier kann der Expositionsweg als Freitext angegeben werden.
Cardinality0...1
Typestring
Must SupportTrue
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
AllergyIntolerance.reaction.note
DefinitionAdditional text about the adverse reaction event not captured in other fields.
Cardinality0...0
TypeAnnotation
Comments

Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.

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: subjectOf.observationEvent[code="annotation"].value
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="epa-allergy-intolerance-amts" />
    <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-allergy-intolerance-amts" />
    <version value="1.1.1" />
    <name value="EPAAllergyIntoleranceAMTS" />
    <title value="EPA Allergy Intolerance AMTSrZI" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="mio42 GmbH" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="AllergyIntolerance" />
    <baseDefinition value="https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance" />
    <derivation value="constraint" />
    <differential>
        <element id="AllergyIntolerance.meta.source">
            <path value="AllergyIntolerance.meta.source" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.meta.security">
            <path value="AllergyIntolerance.meta.security" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.meta.tag">
            <path value="AllergyIntolerance.meta.tag" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.implicitRules">
            <path value="AllergyIntolerance.implicitRules" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.language">
            <path value="AllergyIntolerance.language" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.text">
            <path value="AllergyIntolerance.text" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.contained">
            <path value="AllergyIntolerance.contained" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.extension">
            <path value="AllergyIntolerance.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <description value="Extensions are always sliced by (at least) url" />
                <ordered value="false" />
                <rules value="closed" />
            </slicing>
            <max value="2" />
        </element>
        <element id="AllergyIntolerance.modifierExtension">
            <path value="AllergyIntolerance.modifierExtension" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.identifier">
            <path value="AllergyIntolerance.identifier" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus.coding.userSelected">
            <path value="AllergyIntolerance.clinicalStatus.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.clinicalStatus.text">
            <path value="AllergyIntolerance.clinicalStatus.text" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.verificationStatus.coding.userSelected">
            <path value="AllergyIntolerance.verificationStatus.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.verificationStatus.text">
            <path value="AllergyIntolerance.verificationStatus.text" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.code.coding">
            <path value="AllergyIntolerance.code.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <max value="3" />
        </element>
        <element id="AllergyIntolerance.code.coding:snomed">
            <path value="AllergyIntolerance.code.coding" />
            <sliceName value="snomed" />
        </element>
        <element id="AllergyIntolerance.code.coding:snomed.userSelected">
            <path value="AllergyIntolerance.code.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.code.coding:ask">
            <path value="AllergyIntolerance.code.coding" />
            <sliceName value="ask" />
        </element>
        <element id="AllergyIntolerance.code.coding:ask.version">
            <path value="AllergyIntolerance.code.coding.version" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.code.coding:ask.userSelected">
            <path value="AllergyIntolerance.code.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.code.coding:atc-de">
            <path value="AllergyIntolerance.code.coding" />
            <sliceName value="atc-de" />
        </element>
        <element id="AllergyIntolerance.code.coding:atc-de.userSelected">
            <path value="AllergyIntolerance.code.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.patient.reference">
            <path value="AllergyIntolerance.patient.reference" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.patient.type">
            <path value="AllergyIntolerance.patient.type" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.patient.display">
            <path value="AllergyIntolerance.patient.display" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.encounter">
            <path value="AllergyIntolerance.encounter" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.recordedDate">
            <path value="AllergyIntolerance.recordedDate" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.recorder.type">
            <path value="AllergyIntolerance.recorder.type" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.asserter.type">
            <path value="AllergyIntolerance.asserter.type" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.asserter.display">
            <path value="AllergyIntolerance.asserter.display" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.lastOccurrence">
            <path value="AllergyIntolerance.lastOccurrence" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.note.author[x]:authorReference">
            <path value="AllergyIntolerance.note.author[x]" />
            <sliceName value="authorReference" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
            </type>
        </element>
        <element id="AllergyIntolerance.note.author[x]:authorReference.type">
            <path value="AllergyIntolerance.note.author[x].type" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.note.author[x]:authorReference.display">
            <path value="AllergyIntolerance.note.author[x].display" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <max value="3" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:snomed">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <sliceName value="snomed" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:snomed.userSelected">
            <path value="AllergyIntolerance.reaction.substance.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:ask">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <sliceName value="ask" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:ask.version">
            <path value="AllergyIntolerance.reaction.substance.coding.version" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:ask.userSelected">
            <path value="AllergyIntolerance.reaction.substance.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:atc-de">
            <path value="AllergyIntolerance.reaction.substance.coding" />
            <sliceName value="atc-de" />
        </element>
        <element id="AllergyIntolerance.reaction.substance.coding:atc-de.userSelected">
            <path value="AllergyIntolerance.reaction.substance.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding">
            <path value="AllergyIntolerance.reaction.manifestation.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <max value="1" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding:snomed">
            <path value="AllergyIntolerance.reaction.manifestation.coding" />
            <sliceName value="snomed" />
        </element>
        <element id="AllergyIntolerance.reaction.manifestation.coding:snomed.userSelected">
            <path value="AllergyIntolerance.reaction.manifestation.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="$this" />
                </discriminator>
                <rules value="closed" />
            </slicing>
            <max value="2" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:snomed">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding" />
            <sliceName value="snomed" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:snomed.userSelected">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:edqmCode">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding" />
            <sliceName value="edqmCode" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.version">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.version" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.userSelected">
            <path value="AllergyIntolerance.reaction.exposureRoute.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="AllergyIntolerance.reaction.note">
            <path value="AllergyIntolerance.reaction.note" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-allergy-intolerance-amts",
    "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-allergy-intolerance-amts",
    "version": "1.1.1",
    "name": "EPAAllergyIntoleranceAMTS",
    "title": "EPA Allergy Intolerance AMTSrZI",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "mio42 GmbH",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "AllergyIntolerance",
    "baseDefinition": "https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "AllergyIntolerance.meta.source",
                "path": "AllergyIntolerance.meta.source",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.meta.security",
                "path": "AllergyIntolerance.meta.security",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.meta.tag",
                "path": "AllergyIntolerance.meta.tag",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.implicitRules",
                "path": "AllergyIntolerance.implicitRules",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.language",
                "path": "AllergyIntolerance.language",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.text",
                "path": "AllergyIntolerance.text",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.contained",
                "path": "AllergyIntolerance.contained",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.extension",
                "path": "AllergyIntolerance.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "description": "Extensions are always sliced by (at least) url",
                    "ordered": false,
                    "rules": "closed"
                },
                "max": "2"
            },
            {
                "id": "AllergyIntolerance.modifierExtension",
                "path": "AllergyIntolerance.modifierExtension",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.identifier",
                "path": "AllergyIntolerance.identifier",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.coding.userSelected",
                "path": "AllergyIntolerance.clinicalStatus.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.clinicalStatus.text",
                "path": "AllergyIntolerance.clinicalStatus.text",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.verificationStatus.coding.userSelected",
                "path": "AllergyIntolerance.verificationStatus.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.verificationStatus.text",
                "path": "AllergyIntolerance.verificationStatus.text",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.code.coding",
                "path": "AllergyIntolerance.code.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "closed"
                },
                "max": "3"
            },
            {
                "id": "AllergyIntolerance.code.coding:snomed",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "snomed"
            },
            {
                "id": "AllergyIntolerance.code.coding:snomed.userSelected",
                "path": "AllergyIntolerance.code.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.code.coding:ask",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "ask"
            },
            {
                "id": "AllergyIntolerance.code.coding:ask.version",
                "path": "AllergyIntolerance.code.coding.version",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.code.coding:ask.userSelected",
                "path": "AllergyIntolerance.code.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.code.coding:atc-de",
                "path": "AllergyIntolerance.code.coding",
                "sliceName": "atc-de"
            },
            {
                "id": "AllergyIntolerance.code.coding:atc-de.userSelected",
                "path": "AllergyIntolerance.code.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.patient.reference",
                "path": "AllergyIntolerance.patient.reference",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.patient.type",
                "path": "AllergyIntolerance.patient.type",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.patient.display",
                "path": "AllergyIntolerance.patient.display",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.encounter",
                "path": "AllergyIntolerance.encounter",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.recordedDate",
                "path": "AllergyIntolerance.recordedDate",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.recorder.type",
                "path": "AllergyIntolerance.recorder.type",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.asserter.type",
                "path": "AllergyIntolerance.asserter.type",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.asserter.display",
                "path": "AllergyIntolerance.asserter.display",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.lastOccurrence",
                "path": "AllergyIntolerance.lastOccurrence",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.note.author[x]:authorReference",
                "path": "AllergyIntolerance.note.author[x]",
                "sliceName": "authorReference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Organization",
                            "http://hl7.org/fhir/StructureDefinition/Patient",
                            "http://hl7.org/fhir/StructureDefinition/Practitioner"
                        ]
                    }
                ]
            },
            {
                "id": "AllergyIntolerance.note.author[x]:authorReference.type",
                "path": "AllergyIntolerance.note.author[x].type",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.note.author[x]:authorReference.display",
                "path": "AllergyIntolerance.note.author[x].display",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "closed"
                },
                "max": "3"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:snomed",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "sliceName": "snomed"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:snomed.userSelected",
                "path": "AllergyIntolerance.reaction.substance.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:ask",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "sliceName": "ask"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:ask.version",
                "path": "AllergyIntolerance.reaction.substance.coding.version",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:ask.userSelected",
                "path": "AllergyIntolerance.reaction.substance.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:atc-de",
                "path": "AllergyIntolerance.reaction.substance.coding",
                "sliceName": "atc-de"
            },
            {
                "id": "AllergyIntolerance.reaction.substance.coding:atc-de.userSelected",
                "path": "AllergyIntolerance.reaction.substance.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding",
                "path": "AllergyIntolerance.reaction.manifestation.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "closed"
                },
                "max": "1"
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding:snomed",
                "path": "AllergyIntolerance.reaction.manifestation.coding",
                "sliceName": "snomed"
            },
            {
                "id": "AllergyIntolerance.reaction.manifestation.coding:snomed.userSelected",
                "path": "AllergyIntolerance.reaction.manifestation.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "$this"
                        }
                    ],
                    "rules": "closed"
                },
                "max": "2"
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:snomed",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding",
                "sliceName": "snomed"
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:snomed.userSelected",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:edqmCode",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding",
                "sliceName": "edqmCode"
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.version",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.version",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.exposureRoute.coding:edqmCode.userSelected",
                "path": "AllergyIntolerance.reaction.exposureRoute.coding.userSelected",
                "max": "0"
            },
            {
                "id": "AllergyIntolerance.reaction.note",
                "path": "AllergyIntolerance.reaction.note",
                "max": "0"
            }
        ]
    }
}

Informationsmodell als LogicalModel

Das Profil basiert auf folgendem Informationsmodell:

mechanismus0..1CodingBinding
snomedCtCode0..1CodingBinding
askCode0..1Coding
atcCodeDeutsch0..1Coding
bezeichnung0..1string
substanzkategorie0..1CodingBinding
snomedCtCode0..1CodingBinding
askCode0..1Coding
atcCodeDeutsch0..1Coding
bezeichnung0..1string
snomedCtCode0..1CodingBinding
bezeichnung0..1string
beschreibung0..1string
schweregrad0..1CodingBinding
ereignisdatumDerReaktion0..1date
edqmCode0..1CodingBinding
snomedCtCode0..1CodingBinding
bezeichnung0..1string
von0..1CodingBinding
bis0..1CodingBinding
von0..1date
bis0..1date
behandelndePersonVzdFhirDirectory0..1Reference()
behandelndePersonEinrichtung0..1Reference()
kontaktperson0..1Reference()
patientInEpa0..1Reference()
behandelndePersonVzdFhirDirectory0..1Reference()
behandelndePersonEinrichtung0..1Reference()
klinischerStatus0..1CodingBinding
gewissheit0..1CodingBinding
kritikalitaet0..1CodingBinding
behandelndePersonVzdFhirDirectory0..1Reference()
einrichtungVzdFhirDirectory0..1Reference()
zeitpunktDerErstellung0..1dateTime
text1..1string


Beispiele

Beispiel Nuss-Allergie:

{
    "resourceType": "AllergyIntolerance",
    "id": "example-epa-allergy-intolerance",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance"
        ]
    },
    "code": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "227493005",
                "version": "http://snomed.info/sct/11000274103/version/20240515",
                "display": "Cashew nut (substance)"
            }
        ]
    },
    "reaction":  [
        {
            "manifestation":  [
                {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "43116000",
                            "version": "http://snomed.info/sct/11000274103/version/20240515",
                            "display": "Ekzem"
                        }
                    ]
                }
            ],
            "exposureRoute": {
                "coding":  [
                    {
                        "system": "http://snomed.info/sct",
                        "code": "26643006",
                        "version": "http://snomed.info/sct/11000274103/version/20240515",
                        "display": "Peroral"
                    }
                ]
            },
            "severity": "severe"
        }
    ],
    "clinicalStatus": {
        "coding":  [
            {
                "code": "active",
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
                "version": "4.0.1",
                "display": "Active"
            }
        ]
    },
    "verificationStatus": {
        "coding":  [
            {
                "code": "confirmed",
                "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
                "version": "4.0.1",
                "display": "Confirmed"
            }
        ]
    },
    "type": "allergy",
    "category":  [
        "medication"
    ],
    "criticality": "high",
    "patient": {
        "identifier": {
            "type": {
                "coding":  [
                    {
                        "code": "KVZ10",
                        "system": "http://fhir.de/CodeSystem/identifier-type-de-basis",
                        "display": "Krankenversichertennummer"
                    }
                ]
            },
            "value": "X110411319",
            "system": "http://fhir.de/sid/gkv/kvid-10"
        }
    },
    "onsetDateTime": "2025-08-01",
    "recorder": {
        "reference": "PractitionerRole/3b4e3403-a4c7-40ee-8792-6a855105d126"
    },
    "asserter": {
        "reference": "PractitionerRole/3856402c-7636-4fbd-98bd-d278852b8e88"
    },
    "note":  [
        {
            "text": "Patient reported a severe rash after taking penicillin."
        }
    ]
}
<AllergyIntolerance xmlns="http://hl7.org/fhir">
    <id value="example-epa-allergy-intolerance" />
    <meta>
        <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-allergy-intolerance" />
    </meta>
    <clinicalStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical" />
            <version value="4.0.1" />
            <code value="active" />
            <display value="Active" />
        </coding>
    </clinicalStatus>
    <verificationStatus>
        <coding>
            <system value="http://terminology.hl7.org/CodeSystem/allergyintolerance-verification" />
            <version value="4.0.1" />
            <code value="confirmed" />
            <display value="Confirmed" />
        </coding>
    </verificationStatus>
    <type value="allergy" />
    <category value="medication" />
    <criticality value="high" />
    <code>
        <coding>
            <system value="http://snomed.info/sct" />
            <version value="http://snomed.info/sct/11000274103/version/20240515" />
            <code value="227493005" />
            <display value="Cashew nut (substance)" />
        </coding>
    </code>
    <patient>
        <identifier>
            <type>
                <coding>
                    <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" />
                    <code value="KVZ10" />
                    <display value="Krankenversichertennummer" />
                </coding>
            </type>
            <system value="http://fhir.de/sid/gkv/kvid-10" />
            <value value="X110411319" />
        </identifier>
    </patient>
    <onsetDateTime value="2025-08-01" />
    <recorder>
        <reference value="PractitionerRole/3b4e3403-a4c7-40ee-8792-6a855105d126" />
    </recorder>
    <asserter>
        <reference value="PractitionerRole/3856402c-7636-4fbd-98bd-d278852b8e88" />
    </asserter>
    <note>
        <text value="Patient reported a severe rash after taking penicillin." />
    </note>
    <reaction>
        <manifestation>
            <coding>
                <system value="http://snomed.info/sct" />
                <version value="http://snomed.info/sct/11000274103/version/20240515" />
                <code value="43116000" />
                <display value="Ekzem" />
            </coding>
        </manifestation>
        <severity value="severe" />
        <exposureRoute>
            <coding>
                <system value="http://snomed.info/sct" />
                <version value="http://snomed.info/sct/11000274103/version/20240515" />
                <code value="26643006" />
                <display value="Peroral" />
            </coding>
        </exposureRoute>
    </reaction>
</AllergyIntolerance>