EPAObservationPregnancyStatus
Das EPAObservationPregnancyStatus
-Profil bildet den Schwangerschaftsstatus eines/einer Patient:in ab.
Profil für gemeinsame Datengrundlage im ePA Medication Service
EPA Pregnancy Status Observation Profile
EPAObservationPregnancyStatus (Observation) | I | Observation | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
status | 1..1 | codeBindingPattern | |
div | I | 1..1 | xhtml |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) |
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) |
status | S Σ ?! | 1..1 | codeBinding |
category | 0..* | CodeableConceptBinding | |
code | S Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
loinc | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
subject | S Σ I | 1..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 1..1 | IdentifierKvid10 |
display | Σ | 0..1 | string |
focus | Σ I | 0..* | Reference(Resource) |
encounter | Σ I | 0..1 | Reference(Encounter) |
effective[x] | S Σ | 1..1 | |
effectiveDateTime | S Σ | 1..1 | dateTime |
issued | Σ | 0..1 | instant |
performer | S Σ I | 0..1 | Reference(Organization | RelatedPerson | Patient | Practitioner | PractitionerRole) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | IdentifierKvid10, IdentifierTelematikId |
display | Σ | 0..1 | string |
value[x] | S Σ I | 0..1 | |
valueCodeableConcept | S Σ I | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
loinc | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
dataAbsentReason | I | 0..1 | CodeableConceptBinding |
interpretation | 0..* | CodeableConceptBinding | |
note | S | 0..* | Annotation |
id | 0..1 | string | |
extension | I | 0..* | Extension |
author[x] | S Σ | 0..1 | |
authorReference | S Σ | 0..1 | Reference(Organization | Patient | Practitioner) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | IdentifierKvid10, IdentifierTelematikId |
display | Σ | 0..1 | string |
time | S Σ | 0..1 | dateTime |
text | S Σ | 1..1 | markdown |
bodySite | 0..1 | CodeableConcept | |
method | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
snomed | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
specimen | I | 0..1 | Reference(Specimen) |
device | I | 0..1 | Reference(Device | DeviceMetric) |
referenceRange | I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
low | I | 0..1 | SimpleQuantity |
high | I | 0..1 | SimpleQuantity |
type | 0..1 | CodeableConceptBinding | |
appliesTo | 0..* | CodeableConcept | |
age | I | 0..1 | Range |
text | 0..1 | string | |
hasMember | S Σ I | 0..1 | Reference(Observation) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) |
component | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | CodeableConcept |
value[x] | Σ | 0..1 | |
valueQuantity | Quantity | ||
valueCodeableConcept | CodeableConcept | ||
valueString | string | ||
valueBoolean | boolean | ||
valueInteger | integer | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueTime | time | ||
valueDateTime | dateTime | ||
valuePeriod | Period | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding |
interpretation | 0..* | CodeableConceptBinding | |
referenceRange | 0..* | see (referenceRange) |
Observation | |
Definition | In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht. |
Cardinality | 0...* |
Alias | Vital Signs, Measurement, Results, Tests |
Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. |
Invariants |
|
Mappings |
|
Observation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Observation.meta | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Observation.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.meta.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.source | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.profile | |
Definition | A 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). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.tag | |
Definition | Tags 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. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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 |
|
Mappings |
|
Observation.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 |
|
Mappings |
|
Observation.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Mappings |
|
Observation.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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, 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 |
|
Mappings |
|
Observation.text.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.text.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.text.status | |
Definition | The 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. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a resource narrative. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | extensions |
Mappings |
|
Observation.text.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Cardinality | 1...1 |
Type | xhtml |
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 |
|
Mappings |
|
Observation.contained | |
Definition | These 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline 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 |
|
Observation.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.identifier | |
Definition | A unique identifier assigned to this observation. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows observations to be distinguished and referenced. |
Invariants |
|
Mappings |
|
Observation.basedOn | |
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
Cardinality | 0...* |
Type | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) |
Summary | True |
Alias | Fulfills |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
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 |
|
Mappings |
|
Observation.partOf | |
Definition | A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Cardinality | 0...* |
Type | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) |
Summary | True |
Alias | Container |
Comments | To link an Observation to an Encounter use |
Invariants |
|
Mappings |
|
Observation.status | |
Definition | Hier wird ein Code aus dem FHIR ValueSet http://hl7.org/fhir/ValueSet/observation-status angegeben. |
Cardinality | 1...1 |
Type | code |
Binding | Codes providing the status of an observation. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized. |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Observation.category | |
Definition | A code that classifies the general type of observation being made. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for high level observation categories. |
Requirements | Used for filtering what observations are retrieved and displayed. |
Comments | In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Mappings |
|
Observation.code | |
Definition | Die Codes in diesem Abschnitt beschreiben das Konzept "Schwangerschaftsstatus". |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes identifying names of simple observations. |
Must Support | True |
Summary | True |
Alias | Name |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants |
|
Mappings |
|
Observation.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.code.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Observation.code.coding:loinc | |
Definition | Der Code in diesem Abschnitt beschreibt das Konzept "Schwangerschaftsstatus". |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAPregnancyStatusLOINCVS (required) |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.code.coding:loinc.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.code.coding:loinc.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.version | |
Definition | The 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.code.coding:loinc.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Observation.code.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.subject | |
Definition | The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Must Support | True |
Summary | True |
Requirements | Observations have no value if you don't know who or what they're about. |
Comments | One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. |
Invariants |
|
Mappings |
|
Observation.subject.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.subject.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.subject.reference | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.subject.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.subject.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | IdentifierKvid10 |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.focus | |
Definition | The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
Cardinality | 0...* |
Type | Reference(Resource) |
Summary | True |
Comments | Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use |
Invariants |
|
Mappings |
|
Observation.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Alias | Context |
Requirements | For some observations it may be important to know the link between an observation and a particular encounter. |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). |
Invariants |
|
Mappings |
|
Observation.effective[x] | |
Definition | Zeitpunkt, an dem die Untersuchung durchgeführt wurde. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Alias | Occurrence |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.effective[x]:effectiveDateTime | |
Definition | Zeitpunkt, an dem die Untersuchung durchgeführt wurde. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Alias | Occurrence |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Invariants |
|
Mappings |
|
Observation.issued | |
Definition | The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | For Observations that don’t require review and verification, it may be the same as the |
Invariants |
|
Mappings |
|
Observation.performer | |
Definition | Hier wird die behandelnde Person/Einrichtung referenziert, die die Beobachtung durchgeführt hat. |
Cardinality | 0...1 |
Type | Reference(Organization | RelatedPerson | Patient | Practitioner | PractitionerRole) |
Must Support | True |
Summary | True |
Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. |
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 |
|
Mappings |
|
Observation.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.performer.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.performer.reference | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.performer.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.performer.identifier | |
Definition | An 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. |
Cardinality | 0...1 |
Type | IdentifierKvid10, IdentifierTelematikId |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.performer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept | |
Definition | Hier wird angeben, ob eine Schwangerschaft vorliegt. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.value[x]:valueCodeableConcept.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
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. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc | |
Definition | Hier wird das Ergebnis als LOINC®-Code aus einem vorgegebenen Valueset angegeben. |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAPregnancyStatusValueLOINCVS (required) |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.version | |
Definition | The 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes specifying why the result ( |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. |
Invariants |
|
Mappings |
|
Observation.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying interpretations of observations. |
Alias | Abnormal Flag |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Comments | Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. |
Invariants |
|
Mappings |
|
Observation.note | |
Definition | Hier können ergänzende freitextliche Kommentare und Notizen vorgenommen werden, die nicht durch die strukturierten Datenelemente erfassbar sind. |
Cardinality | 0...* |
Type | Annotation |
Must Support | True |
Requirements | Need to be able to provide free text additional information. |
Comments | May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. |
Invariants |
|
Mappings |
|
Observation.note.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.note.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.note.author[x] | |
Definition | Hier wird die Person referenziert, die die Notiz erstellt hat. |
Cardinality | 0...1 |
Type | Reference(Practitioner | Patient | RelatedPerson | Organization) |
Must Support | True |
Summary | True |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.note.author[x]:authorReference | |
Definition | The individual responsible for making the annotation. |
Cardinality | 0...1 |
Type | Reference(Organization | Patient | Practitioner) |
Must Support | True |
Summary | True |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Invariants |
|
Mappings |
|
Observation.note.author[x]:authorReference.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.note.author[x]:authorReference.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.note.author[x]:authorReference.reference | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.note.author[x]:authorReference.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.note.author[x]:authorReference.identifier | |
Definition | An 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. |
Cardinality | 0...1 |
Type | IdentifierKvid10, IdentifierTelematikId |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.note.author[x]:authorReference.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.note.time | |
Definition | Hier wird der Zeitpunkt angegeben, zu dem die Notiz erstellt wurde. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | Dieses Element sollte in der Regel automatisiert ohne Aufwand für die Person, die die Notiz erstellt befüllt werden. |
Invariants |
|
Mappings |
|
Observation.note.text | |
Definition | Hier wird der eigentliche Text der Notiz eingetragen. |
Cardinality | 1...1 |
Type | markdown |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes describing anatomical locations. May include laterality. |
Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite. |
Invariants |
|
Mappings |
|
Observation.method | |
Definition | Hier wird die Methode der Untersuchung anhand eines entsprechenden Codes oder alternativ mit einem Freitext angegeben. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Methods for simple observations. |
Must Support | True |
Requirements | In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. |
Comments | Only used if not implicit in code for Observation.code. |
Invariants |
|
Mappings |
|
Observation.method.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.method.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.method.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
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. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
Observation.method.coding:snomed | |
Definition | Hier wird die Methode der Untersuchung als entsprechender SNOMED CT®-Code angegeben. |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAPregnancyStatusMethodSNOMEDCTVS (required) |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.method.coding:snomed.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.method.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.version | |
Definition | The 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.method.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Observation.method.text | |
Definition | Hier wird ein Freitext eingetragen. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.specimen | |
Definition | The specimen that was used when this observation was made. |
Cardinality | 0...1 |
Type | Reference(Specimen) |
Comments | Should only be used if not implicit in code found in |
Invariants |
|
Mappings |
|
Observation.device | |
Definition | The device used to generate the observation data. |
Cardinality | 0...1 |
Type | Reference(Device | DeviceMetric) |
Comments | Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. |
Invariants |
|
Mappings |
|
Observation.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Invariants |
|
Mappings |
|
Observation.referenceRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.referenceRange.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.referenceRange.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Observation.referenceRange.low | |
Definition | The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
Cardinality | 0...1 |
Type | SimpleQuantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Observation.referenceRange.high | |
Definition | The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
Cardinality | 0...1 |
Type | SimpleQuantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Observation.referenceRange.type | |
Definition | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Code for the meaning of a reference range. |
Requirements | Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. |
Invariants |
|
Mappings |
|
Observation.referenceRange.appliesTo | |
Definition | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying the population the reference range applies to. |
Requirements | Need to be able to identify the target population for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. |
Invariants |
|
Mappings |
|
Observation.referenceRange.age | |
Definition | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
Cardinality | 0...1 |
Type | Range |
Requirements | Some analytes vary greatly over age. |
Comments | The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. |
Invariants |
|
Mappings |
|
Observation.referenceRange.text | |
Definition | Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals". |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.hasMember | |
Definition | Hier kann der zu einer vorliegenden Schwangerschaft gehörende geschätzte Entbindungstermin referenziert werden. |
Cardinality | 0...1 |
Type | Reference(Observation) |
Must Support | True |
Summary | True |
Comments | EPAObservationEstimatedDateOfDelivery |
Invariants |
|
Mappings |
|
Observation.hasMember.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.hasMember.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.hasMember.reference | |
Definition | A 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.hasMember.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.hasMember.identifier | |
Definition | An 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. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
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 |
|
Mappings |
|
Observation.hasMember.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.derivedFrom | |
Definition | The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Cardinality | 0...* |
Type | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) |
Summary | True |
Comments | All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Invariants |
|
Mappings |
|
Observation.component | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants |
|
Mappings |
|
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.component.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.component.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Observation.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes identifying names of simple observations. |
Summary | True |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants |
|
Mappings |
|
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes specifying why the result ( |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. |
Invariants |
|
Mappings |
|
Observation.component.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying interpretations of observations. |
Alias | Abnormal Flag |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Comments | Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. |
Invariants |
|
Mappings |
|
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Cardinality | 0...* |
Type | see (referenceRange) |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-observation-pregnancy-status" /> <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> <version value="1.1.0" /> <name value="EPAObservationPregnancyStatus" /> <title value="EPA Pregnancy Status Observation Profile" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="mio42 GmbH" /> <description value="In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Observation" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Observation" /> <derivation value="constraint" /> <differential> <element id="Observation"> <path value="Observation" /> <definition value="In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht." /> <constraint> <key value="obs-epa-1" /> <severity value="error" /> <human value="At least year, month and day are needed" /> <expression value="(effective as dateTime).toString().length() >= 10" /> <source value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> </constraint> <constraint> <key value="obs-epa-2" /> <severity value="error" /> <human value="If it is a valid Observation it must have a value otherwise it must not have a value" /> <expression value="(Observation.value.exists() implies (Observation.status in ('final' | 'amended' | 'corrected' | 'preliminary')))" /> <source value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> </constraint> </element> <element id="Observation.meta"> <path value="Observation.meta" /> <mustSupport value="true" /> </element> <element id="Observation.meta.versionId"> <path value="Observation.meta.versionId" /> <mustSupport value="true" /> </element> <element id="Observation.meta.lastUpdated"> <path value="Observation.meta.lastUpdated" /> <mustSupport value="true" /> </element> <element id="Observation.text"> <path value="Observation.text" /> <definition value="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." /> </element> <element id="Observation.text.status"> <path value="Observation.text.status" /> <patternCode value="extensions" /> </element> <element id="Observation.status"> <path value="Observation.status" /> <definition value="Hier wird ein Code aus dem FHIR ValueSet http://hl7.org/fhir/ValueSet/observation-status angegeben." /> <mustSupport value="true" /> </element> <element id="Observation.code"> <path value="Observation.code" /> <definition value="Die Codes in diesem Abschnitt beschreiben das Konzept "Schwangerschaftsstatus"." /> <mustSupport value="true" /> </element> <element id="Observation.code.coding"> <path value="Observation.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc"> <path value="Observation.code.coding" /> <sliceName value="loinc" /> <definition value="Der Code in diesem Abschnitt beschreibt das Konzept "Schwangerschaftsstatus"." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-loinc-vs" /> </binding> </element> <element id="Observation.code.coding:loinc.system"> <path value="Observation.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc.version"> <path value="Observation.code.coding.version" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc.code"> <path value="Observation.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc.display"> <path value="Observation.code.coding.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.subject"> <path value="Observation.subject" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> </type> <mustSupport value="true" /> </element> <element id="Observation.subject.identifier"> <path value="Observation.subject.identifier" /> <min value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" /> </type> <mustSupport value="true" /> </element> <element id="Observation.effective[x]"> <path value="Observation.effective[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <definition value="Zeitpunkt, an dem die Untersuchung durchgeführt wurde." /> <min value="1" /> <type> <code value="dateTime" /> </type> <mustSupport value="true" /> </element> <element id="Observation.effective[x]:effectiveDateTime"> <path value="Observation.effective[x]" /> <sliceName value="effectiveDateTime" /> <definition value="Zeitpunkt, an dem die Untersuchung durchgeführt wurde." /> <min value="1" /> <max value="1" /> <type> <code value="dateTime" /> </type> <mustSupport value="true" /> </element> <element id="Observation.performer"> <path value="Observation.performer" /> <definition value="Hier wird die behandelnde Person/Einrichtung referenziert, die die Beobachtung durchgeführt hat." /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> </type> <mustSupport value="true" /> </element> <element id="Observation.performer.reference"> <path value="Observation.performer.reference" /> <mustSupport value="true" /> </element> <element id="Observation.performer.identifier"> <path value="Observation.performer.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="Observation.value[x]"> <path value="Observation.value[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept"> <path value="Observation.value[x]" /> <sliceName value="valueCodeableConcept" /> <definition value="Hier wird angeben, ob eine Schwangerschaft vorliegt." /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding"> <path value="Observation.value[x].coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc"> <path value="Observation.value[x].coding" /> <sliceName value="loinc" /> <definition value="Hier wird das Ergebnis als LOINC®-Code aus einem vorgegebenen Valueset angegeben." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-value-loinc-vs" /> </binding> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.system"> <path value="Observation.value[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.version"> <path value="Observation.value[x].coding.version" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.code"> <path value="Observation.value[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.display"> <path value="Observation.value[x].coding.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.note"> <path value="Observation.note" /> <definition value="Hier können ergänzende freitextliche Kommentare und Notizen vorgenommen werden, die nicht durch die strukturierten Datenelemente erfassbar sind." /> <mustSupport value="true" /> </element> <element id="Observation.note.author[x]"> <path value="Observation.note.author[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <definition value="Hier wird die Person 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="Observation.note.author[x]:authorReference"> <path value="Observation.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="Observation.note.author[x]:authorReference.reference"> <path value="Observation.note.author[x].reference" /> <mustSupport value="true" /> </element> <element id="Observation.note.author[x]:authorReference.identifier"> <path value="Observation.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="Observation.note.time"> <path value="Observation.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ür die Person, die die Notiz erstellt befüllt werden." /> <mustSupport value="true" /> </element> <element id="Observation.note.text"> <path value="Observation.note.text" /> <definition value="Hier wird der eigentliche Text der Notiz eingetragen." /> <mustSupport value="true" /> </element> <element id="Observation.method"> <path value="Observation.method" /> <definition value="Hier wird die Methode der Untersuchung anhand eines entsprechenden Codes oder alternativ mit einem Freitext angegeben." /> <mustSupport value="true" /> </element> <element id="Observation.method.coding"> <path value="Observation.method.coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed"> <path value="Observation.method.coding" /> <sliceName value="snomed" /> <definition value="Hier wird die Methode der Untersuchung als entsprechender SNOMED CT®-Code angegeben." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-method-snomed-ct-vs" /> </binding> </element> <element id="Observation.method.coding:snomed.system"> <path value="Observation.method.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed.version"> <path value="Observation.method.coding.version" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed.code"> <path value="Observation.method.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed.display"> <path value="Observation.method.coding.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.text"> <path value="Observation.method.text" /> <definition value="Hier wird ein Freitext eingetragen." /> <mustSupport value="true" /> </element> <element id="Observation.hasMember"> <path value="Observation.hasMember" /> <definition value="Hier kann der zu einer vorliegenden Schwangerschaft gehörende geschätzte Entbindungstermin referenziert werden." /> <comment value="EPAObservationEstimatedDateOfDelivery" /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" /> </type> <mustSupport value="true" /> </element> <element id="Observation.hasMember.reference"> <path value="Observation.hasMember.reference" /> <min value="1" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-observation-pregnancy-status", "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status", "version": "1.1.0", "name": "EPAObservationPregnancyStatus", "title": "EPA Pregnancy Status Observation Profile", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "mio42 GmbH", "description": "In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Observation", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "derivation": "constraint", "differential": { "element": [ { "id": "Observation", "path": "Observation", "definition": "In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht.", "constraint": [ { "key": "obs-epa-1", "severity": "error", "human": "At least year, month and day are needed", "expression": "(effective as dateTime).toString().length() >= 10", "source": "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" }, { "key": "obs-epa-2", "severity": "error", "human": "If it is a valid Observation it must have a value otherwise it must not have a value", "expression": "(Observation.value.exists() implies (Observation.status in ('final' | 'amended' | 'corrected' | 'preliminary')))", "source": "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" } ] }, { "id": "Observation.meta", "path": "Observation.meta", "mustSupport": true }, { "id": "Observation.meta.versionId", "path": "Observation.meta.versionId", "mustSupport": true }, { "id": "Observation.meta.lastUpdated", "path": "Observation.meta.lastUpdated", "mustSupport": true }, { "id": "Observation.text", "path": "Observation.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": "Observation.text.status", "path": "Observation.text.status", "patternCode": "extensions" }, { "id": "Observation.status", "path": "Observation.status", "definition": "Hier wird ein Code aus dem FHIR ValueSet http://hl7.org/fhir/ValueSet/observation-status angegeben.", "mustSupport": true }, { "id": "Observation.code", "path": "Observation.code", "definition": "Die Codes in diesem Abschnitt beschreiben das Konzept \"Schwangerschaftsstatus\".", "mustSupport": true }, { "id": "Observation.code.coding", "path": "Observation.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc", "path": "Observation.code.coding", "sliceName": "loinc", "definition": "Der Code in diesem Abschnitt beschreibt das Konzept \"Schwangerschaftsstatus\".", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-loinc-vs" } }, { "id": "Observation.code.coding:loinc.system", "path": "Observation.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc.version", "path": "Observation.code.coding.version", "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc.code", "path": "Observation.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc.display", "path": "Observation.code.coding.display", "min": 1, "mustSupport": true }, { "id": "Observation.subject", "path": "Observation.subject", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "mustSupport": true }, { "id": "Observation.subject.identifier", "path": "Observation.subject.identifier", "min": 1, "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-kvid-10" ] } ], "mustSupport": true }, { "id": "Observation.effective[x]", "path": "Observation.effective[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "closed" }, "definition": "Zeitpunkt, an dem die Untersuchung durchgeführt wurde.", "min": 1, "type": [ { "code": "dateTime" } ], "mustSupport": true }, { "id": "Observation.effective[x]:effectiveDateTime", "path": "Observation.effective[x]", "sliceName": "effectiveDateTime", "definition": "Zeitpunkt, an dem die Untersuchung durchgeführt wurde.", "min": 1, "max": "1", "type": [ { "code": "dateTime" } ], "mustSupport": true }, { "id": "Observation.performer", "path": "Observation.performer", "definition": "Hier wird die behandelnde Person/Einrichtung referenziert, die die Beobachtung durchgeführt hat.", "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] } ], "mustSupport": true }, { "id": "Observation.performer.reference", "path": "Observation.performer.reference", "mustSupport": true }, { "id": "Observation.performer.identifier", "path": "Observation.performer.identifier", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-kvid-10", "http://fhir.de/StructureDefinition/identifier-telematik-id" ] } ], "mustSupport": true }, { "id": "Observation.value[x]", "path": "Observation.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "closed" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept", "path": "Observation.value[x]", "sliceName": "valueCodeableConcept", "definition": "Hier wird angeben, ob eine Schwangerschaft vorliegt.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding", "path": "Observation.value[x].coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc", "path": "Observation.value[x].coding", "sliceName": "loinc", "definition": "Hier wird das Ergebnis als LOINC®-Code aus einem vorgegebenen Valueset angegeben.", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-value-loinc-vs" } }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.system", "path": "Observation.value[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.version", "path": "Observation.value[x].coding.version", "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.code", "path": "Observation.value[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.display", "path": "Observation.value[x].coding.display", "min": 1, "mustSupport": true }, { "id": "Observation.note", "path": "Observation.note", "definition": "Hier können ergänzende freitextliche Kommentare und Notizen vorgenommen werden, die nicht durch die strukturierten Datenelemente erfassbar sind.", "mustSupport": true }, { "id": "Observation.note.author[x]", "path": "Observation.note.author[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "closed" }, "definition": "Hier wird die Person 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": "Observation.note.author[x]:authorReference", "path": "Observation.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": "Observation.note.author[x]:authorReference.reference", "path": "Observation.note.author[x].reference", "mustSupport": true }, { "id": "Observation.note.author[x]:authorReference.identifier", "path": "Observation.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": "Observation.note.time", "path": "Observation.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": "Observation.note.text", "path": "Observation.note.text", "definition": "Hier wird der eigentliche Text der Notiz eingetragen.", "mustSupport": true }, { "id": "Observation.method", "path": "Observation.method", "definition": "Hier wird die Methode der Untersuchung anhand eines entsprechenden Codes oder alternativ mit einem Freitext angegeben.", "mustSupport": true }, { "id": "Observation.method.coding", "path": "Observation.method.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed", "path": "Observation.method.coding", "sliceName": "snomed", "definition": "Hier wird die Methode der Untersuchung als entsprechender SNOMED CT®-Code angegeben.", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-method-snomed-ct-vs" } }, { "id": "Observation.method.coding:snomed.system", "path": "Observation.method.coding.system", "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed.version", "path": "Observation.method.coding.version", "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed.code", "path": "Observation.method.coding.code", "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed.display", "path": "Observation.method.coding.display", "min": 1, "mustSupport": true }, { "id": "Observation.method.text", "path": "Observation.method.text", "definition": "Hier wird ein Freitext eingetragen.", "mustSupport": true }, { "id": "Observation.hasMember", "path": "Observation.hasMember", "definition": "Hier kann der zu einer vorliegenden Schwangerschaft gehörende geschätzte Entbindungstermin referenziert werden.", "comment": "EPAObservationEstimatedDateOfDelivery", "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ], "mustSupport": true }, { "id": "Observation.hasMember.reference", "path": "Observation.hasMember.reference", "min": 1, "mustSupport": true } ] } }
Profil für die Datenverwaltung im Kontext der Medikationsplanung
EPA Pregnancy Status Observation Profile
EPAObservationPregnancyStatus (Observation) | I | Observation | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
status | 1..1 | codeBindingPattern | |
div | I | 1..1 | xhtml |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
basedOn | Σ I | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) |
partOf | Σ I | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) |
status | S Σ ?! | 1..1 | codeBinding |
category | 0..* | CodeableConceptBinding | |
code | S Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
loinc | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
subject | S Σ I | 1..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 1..1 | IdentifierKvid10 |
display | Σ | 0..1 | string |
focus | Σ I | 0..* | Reference(Resource) |
encounter | Σ I | 0..1 | Reference(Encounter) |
effective[x] | S Σ | 1..1 | |
effectiveDateTime | S Σ | 1..1 | dateTime |
issued | Σ | 0..1 | instant |
performer | S Σ I | 0..1 | Reference(Organization | RelatedPerson | Patient | Practitioner | PractitionerRole) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | IdentifierKvid10, IdentifierTelematikId |
display | Σ | 0..1 | string |
value[x] | S Σ I | 0..1 | |
valueCodeableConcept | S Σ I | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
loinc | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
dataAbsentReason | I | 0..1 | CodeableConceptBinding |
interpretation | 0..* | CodeableConceptBinding | |
note | S | 0..* | Annotation |
id | 0..1 | string | |
extension | I | 0..* | Extension |
author[x] | S Σ | 0..1 | |
authorReference | S Σ | 0..1 | Reference(Organization | Patient | Practitioner) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | IdentifierKvid10, IdentifierTelematikId |
display | Σ | 0..1 | string |
time | S Σ | 0..1 | dateTime |
text | S Σ | 1..1 | markdown |
bodySite | 0..1 | CodeableConcept | |
method | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
snomed | S Σ | 1..1 | CodingBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | S Σ | 1..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
specimen | I | 0..1 | Reference(Specimen) |
device | I | 0..1 | Reference(Device | DeviceMetric) |
referenceRange | I | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
low | I | 0..1 | SimpleQuantity |
high | I | 0..1 | SimpleQuantity |
type | 0..1 | CodeableConceptBinding | |
appliesTo | 0..* | CodeableConcept | |
age | I | 0..1 | Range |
text | 0..1 | string | |
hasMember | S Σ I | 0..1 | Reference(Observation) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
derivedFrom | Σ I | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) |
component | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | CodeableConcept |
value[x] | Σ | 0..1 | |
valueQuantity | Quantity | ||
valueCodeableConcept | CodeableConcept | ||
valueString | string | ||
valueBoolean | boolean | ||
valueInteger | integer | ||
valueRange | Range | ||
valueRatio | Ratio | ||
valueSampledData | SampledData | ||
valueTime | time | ||
valueDateTime | dateTime | ||
valuePeriod | Period | ||
dataAbsentReason | I | 0..1 | CodeableConceptBinding |
interpretation | 0..* | CodeableConceptBinding | |
referenceRange | 0..* | see (referenceRange) |
Observation | |
Definition | In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht. |
Cardinality | 0...* |
Alias | Vital Signs, Measurement, Results, Tests |
Comments | Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. |
Invariants |
|
Mappings |
|
Observation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Observation.meta | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Observation.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.meta.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.source | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.profile | |
Definition | A 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). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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 |
|
Mappings |
|
Observation.meta.tag | |
Definition | Tags 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. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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 |
|
Mappings |
|
Observation.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 |
|
Mappings |
|
Observation.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Mappings |
|
Observation.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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, 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 |
|
Mappings |
|
Observation.text.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.text.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.text.status | |
Definition | The 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. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a resource narrative. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Pattern | extensions |
Mappings |
|
Observation.text.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Cardinality | 1...1 |
Type | xhtml |
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 |
|
Mappings |
|
Observation.contained | |
Definition | These 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline 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 |
|
Observation.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.identifier | |
Definition | A unique identifier assigned to this observation. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows observations to be distinguished and referenced. |
Invariants |
|
Mappings |
|
Observation.basedOn | |
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
Cardinality | 0...* |
Type | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) |
Summary | True |
Alias | Fulfills |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
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 |
|
Mappings |
|
Observation.partOf | |
Definition | A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Cardinality | 0...* |
Type | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) |
Summary | True |
Alias | Container |
Comments | To link an Observation to an Encounter use |
Invariants |
|
Mappings |
|
Observation.status | |
Definition | Hier wird ein Code aus dem FHIR ValueSet http://hl7.org/fhir/ValueSet/observation-status angegeben. |
Cardinality | 1...1 |
Type | code |
Binding | Codes providing the status of an observation. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized. |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Observation.category | |
Definition | A code that classifies the general type of observation being made. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes for high level observation categories. |
Requirements | Used for filtering what observations are retrieved and displayed. |
Comments | In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Mappings |
|
Observation.code | |
Definition | Die Codes in diesem Abschnitt beschreiben das Konzept "Schwangerschaftsstatus". |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes identifying names of simple observations. |
Must Support | True |
Summary | True |
Alias | Name |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants |
|
Mappings |
|
Observation.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.code.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Observation.code.coding:loinc | |
Definition | Der Code in diesem Abschnitt beschreibt das Konzept "Schwangerschaftsstatus". |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAPregnancyStatusLOINCVS (required) |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.code.coding:loinc.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.code.coding:loinc.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.version | |
Definition | The 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.code.coding:loinc.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.code.coding:loinc.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Observation.code.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.subject | |
Definition | The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Must Support | True |
Summary | True |
Requirements | Observations have no value if you don't know who or what they're about. |
Comments | One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. |
Invariants |
|
Mappings |
|
Observation.subject.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.subject.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.subject.reference | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.subject.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.subject.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | IdentifierKvid10 |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.focus | |
Definition | The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
Cardinality | 0...* |
Type | Reference(Resource) |
Summary | True |
Comments | Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use |
Invariants |
|
Mappings |
|
Observation.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Alias | Context |
Requirements | For some observations it may be important to know the link between an observation and a particular encounter. |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). |
Invariants |
|
Mappings |
|
Observation.effective[x] | |
Definition | Zeitpunkt, an dem die Untersuchung durchgeführt wurde. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Alias | Occurrence |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.effective[x]:effectiveDateTime | |
Definition | Zeitpunkt, an dem die Untersuchung durchgeführt wurde. |
Cardinality | 1...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Alias | Occurrence |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Invariants |
|
Mappings |
|
Observation.issued | |
Definition | The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | For Observations that don’t require review and verification, it may be the same as the |
Invariants |
|
Mappings |
|
Observation.performer | |
Definition | Hier wird die behandelnde Person/Einrichtung referenziert, die die Beobachtung durchgeführt hat. |
Cardinality | 0...1 |
Type | Reference(Organization | RelatedPerson | Patient | Practitioner | PractitionerRole) |
Must Support | True |
Summary | True |
Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. |
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 |
|
Mappings |
|
Observation.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.performer.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.performer.reference | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.performer.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.performer.identifier | |
Definition | An 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. |
Cardinality | 0...1 |
Type | IdentifierKvid10, IdentifierTelematikId |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.performer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept | |
Definition | Hier wird angeben, ob eine Schwangerschaft vorliegt. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.value[x]:valueCodeableConcept.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
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. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc | |
Definition | Hier wird das Ergebnis als LOINC®-Code aus einem vorgegebenen Valueset angegeben. |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAPregnancyStatusValueLOINCVS (required) |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.version | |
Definition | The 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.coding:loinc.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes specifying why the result ( |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. |
Invariants |
|
Mappings |
|
Observation.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying interpretations of observations. |
Alias | Abnormal Flag |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Comments | Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. |
Invariants |
|
Mappings |
|
Observation.note | |
Definition | Hier können ergänzende freitextliche Kommentare und Notizen vorgenommen werden, die nicht durch die strukturierten Datenelemente erfassbar sind. |
Cardinality | 0...* |
Type | Annotation |
Must Support | True |
Requirements | Need to be able to provide free text additional information. |
Comments | May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. |
Invariants |
|
Mappings |
|
Observation.note.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.note.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.note.author[x] | |
Definition | Hier wird die Person referenziert, die die Notiz erstellt hat. |
Cardinality | 0...1 |
Type | Reference(Practitioner | Patient | RelatedPerson | Organization) |
Must Support | True |
Summary | True |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.note.author[x]:authorReference | |
Definition | The individual responsible for making the annotation. |
Cardinality | 0...1 |
Type | Reference(Organization | Patient | Practitioner) |
Must Support | True |
Summary | True |
Comments | Organization is used when there's no need for specific attribution as to who made the comment. |
Invariants |
|
Mappings |
|
Observation.note.author[x]:authorReference.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.note.author[x]:authorReference.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.note.author[x]:authorReference.reference | |
Definition | A 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.note.author[x]:authorReference.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.note.author[x]:authorReference.identifier | |
Definition | An 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. |
Cardinality | 0...1 |
Type | IdentifierKvid10, IdentifierTelematikId |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.note.author[x]:authorReference.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.note.time | |
Definition | Hier wird der Zeitpunkt angegeben, zu dem die Notiz erstellt wurde. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Comments | Dieses Element sollte in der Regel automatisiert ohne Aufwand für die Person, die die Notiz erstellt befüllt werden. |
Invariants |
|
Mappings |
|
Observation.note.text | |
Definition | Hier wird der eigentliche Text der Notiz eingetragen. |
Cardinality | 1...1 |
Type | markdown |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes describing anatomical locations. May include laterality. |
Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite. |
Invariants |
|
Mappings |
|
Observation.method | |
Definition | Hier wird die Methode der Untersuchung anhand eines entsprechenden Codes oder alternativ mit einem Freitext angegeben. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Methods for simple observations. |
Must Support | True |
Requirements | In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. |
Comments | Only used if not implicit in code for Observation.code. |
Invariants |
|
Mappings |
|
Observation.method.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.method.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.method.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
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. |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
Observation.method.coding:snomed | |
Definition | Hier wird die Methode der Untersuchung als entsprechender SNOMED CT®-Code angegeben. |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAPregnancyStatusMethodSNOMEDCTVS (required) |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.method.coding:snomed.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.method.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.version | |
Definition | The 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.method.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.method.coding:snomed.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Observation.method.text | |
Definition | Hier wird ein Freitext eingetragen. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.specimen | |
Definition | The specimen that was used when this observation was made. |
Cardinality | 0...1 |
Type | Reference(Specimen) |
Comments | Should only be used if not implicit in code found in |
Invariants |
|
Mappings |
|
Observation.device | |
Definition | The device used to generate the observation data. |
Cardinality | 0...1 |
Type | Reference(Device | DeviceMetric) |
Comments | Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. |
Invariants |
|
Mappings |
|
Observation.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Invariants |
|
Mappings |
|
Observation.referenceRange.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.referenceRange.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.referenceRange.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Observation.referenceRange.low | |
Definition | The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
Cardinality | 0...1 |
Type | SimpleQuantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Observation.referenceRange.high | |
Definition | The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
Cardinality | 0...1 |
Type | SimpleQuantity |
Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Invariants |
|
Mappings |
|
Observation.referenceRange.type | |
Definition | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Code for the meaning of a reference range. |
Requirements | Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. |
Invariants |
|
Mappings |
|
Observation.referenceRange.appliesTo | |
Definition | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying the population the reference range applies to. |
Requirements | Need to be able to identify the target population for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. |
Invariants |
|
Mappings |
|
Observation.referenceRange.age | |
Definition | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
Cardinality | 0...1 |
Type | Range |
Requirements | Some analytes vary greatly over age. |
Comments | The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. |
Invariants |
|
Mappings |
|
Observation.referenceRange.text | |
Definition | Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals". |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Observation.hasMember | |
Definition | Hier kann der zu einer vorliegenden Schwangerschaft gehörende geschätzte Entbindungstermin referenziert werden. |
Cardinality | 0...1 |
Type | Reference(Observation) |
Must Support | True |
Summary | True |
Comments | EPAObservationEstimatedDateOfDelivery |
Invariants |
|
Mappings |
|
Observation.hasMember.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.hasMember.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.hasMember.reference | |
Definition | A 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. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Observation.hasMember.type | |
Definition | The 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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
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 |
|
Mappings |
|
Observation.hasMember.identifier | |
Definition | An 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. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
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 |
|
Mappings |
|
Observation.hasMember.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 |
|
Mappings |
|
Observation.derivedFrom | |
Definition | The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Cardinality | 0...* |
Type | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) |
Summary | True |
Comments | All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Invariants |
|
Mappings |
|
Observation.component | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants |
|
Mappings |
|
Observation.component.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Observation.component.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Observation.component.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Observation.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes identifying names of simple observations. |
Summary | True |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants |
|
Mappings |
|
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes specifying why the result ( |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. |
Invariants |
|
Mappings |
|
Observation.component.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying interpretations of observations. |
Alias | Abnormal Flag |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Comments | Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. |
Invariants |
|
Mappings |
|
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Cardinality | 0...* |
Type | see (referenceRange) |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-observation-pregnancy-status" /> <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> <version value="1.1.0" /> <name value="EPAObservationPregnancyStatus" /> <title value="EPA Pregnancy Status Observation Profile" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="mio42 GmbH" /> <description value="In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Observation" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Observation" /> <derivation value="constraint" /> <differential> <element id="Observation"> <path value="Observation" /> <definition value="In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht." /> <constraint> <key value="obs-epa-1" /> <severity value="error" /> <human value="At least year, month and day are needed" /> <expression value="(effective as dateTime).toString().length() >= 10" /> <source value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> </constraint> <constraint> <key value="obs-epa-2" /> <severity value="error" /> <human value="If it is a valid Observation it must have a value otherwise it must not have a value" /> <expression value="(Observation.value.exists() implies (Observation.status in ('final' | 'amended' | 'corrected' | 'preliminary')))" /> <source value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> </constraint> </element> <element id="Observation.meta"> <path value="Observation.meta" /> <mustSupport value="true" /> </element> <element id="Observation.meta.versionId"> <path value="Observation.meta.versionId" /> <mustSupport value="true" /> </element> <element id="Observation.meta.lastUpdated"> <path value="Observation.meta.lastUpdated" /> <mustSupport value="true" /> </element> <element id="Observation.text"> <path value="Observation.text" /> <definition value="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." /> </element> <element id="Observation.text.status"> <path value="Observation.text.status" /> <patternCode value="extensions" /> </element> <element id="Observation.status"> <path value="Observation.status" /> <definition value="Hier wird ein Code aus dem FHIR ValueSet http://hl7.org/fhir/ValueSet/observation-status angegeben." /> <mustSupport value="true" /> </element> <element id="Observation.code"> <path value="Observation.code" /> <definition value="Die Codes in diesem Abschnitt beschreiben das Konzept "Schwangerschaftsstatus"." /> <mustSupport value="true" /> </element> <element id="Observation.code.coding"> <path value="Observation.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc"> <path value="Observation.code.coding" /> <sliceName value="loinc" /> <definition value="Der Code in diesem Abschnitt beschreibt das Konzept "Schwangerschaftsstatus"." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-loinc-vs" /> </binding> </element> <element id="Observation.code.coding:loinc.system"> <path value="Observation.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc.version"> <path value="Observation.code.coding.version" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc.code"> <path value="Observation.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.code.coding:loinc.display"> <path value="Observation.code.coding.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.subject"> <path value="Observation.subject" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> </type> <mustSupport value="true" /> </element> <element id="Observation.subject.identifier"> <path value="Observation.subject.identifier" /> <min value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" /> </type> <mustSupport value="true" /> </element> <element id="Observation.effective[x]"> <path value="Observation.effective[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <definition value="Zeitpunkt, an dem die Untersuchung durchgeführt wurde." /> <min value="1" /> <type> <code value="dateTime" /> </type> <mustSupport value="true" /> </element> <element id="Observation.effective[x]:effectiveDateTime"> <path value="Observation.effective[x]" /> <sliceName value="effectiveDateTime" /> <definition value="Zeitpunkt, an dem die Untersuchung durchgeführt wurde." /> <min value="1" /> <max value="1" /> <type> <code value="dateTime" /> </type> <mustSupport value="true" /> </element> <element id="Observation.performer"> <path value="Observation.performer" /> <definition value="Hier wird die behandelnde Person/Einrichtung referenziert, die die Beobachtung durchgeführt hat." /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> </type> <mustSupport value="true" /> </element> <element id="Observation.performer.reference"> <path value="Observation.performer.reference" /> <mustSupport value="true" /> </element> <element id="Observation.performer.identifier"> <path value="Observation.performer.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="Observation.value[x]"> <path value="Observation.value[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept"> <path value="Observation.value[x]" /> <sliceName value="valueCodeableConcept" /> <definition value="Hier wird angeben, ob eine Schwangerschaft vorliegt." /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding"> <path value="Observation.value[x].coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc"> <path value="Observation.value[x].coding" /> <sliceName value="loinc" /> <definition value="Hier wird das Ergebnis als LOINC®-Code aus einem vorgegebenen Valueset angegeben." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-value-loinc-vs" /> </binding> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.system"> <path value="Observation.value[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.version"> <path value="Observation.value[x].coding.version" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.code"> <path value="Observation.value[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.value[x]:valueCodeableConcept.coding:loinc.display"> <path value="Observation.value[x].coding.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.note"> <path value="Observation.note" /> <definition value="Hier können ergänzende freitextliche Kommentare und Notizen vorgenommen werden, die nicht durch die strukturierten Datenelemente erfassbar sind." /> <mustSupport value="true" /> </element> <element id="Observation.note.author[x]"> <path value="Observation.note.author[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <definition value="Hier wird die Person 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="Observation.note.author[x]:authorReference"> <path value="Observation.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="Observation.note.author[x]:authorReference.reference"> <path value="Observation.note.author[x].reference" /> <mustSupport value="true" /> </element> <element id="Observation.note.author[x]:authorReference.identifier"> <path value="Observation.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="Observation.note.time"> <path value="Observation.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ür die Person, die die Notiz erstellt befüllt werden." /> <mustSupport value="true" /> </element> <element id="Observation.note.text"> <path value="Observation.note.text" /> <definition value="Hier wird der eigentliche Text der Notiz eingetragen." /> <mustSupport value="true" /> </element> <element id="Observation.method"> <path value="Observation.method" /> <definition value="Hier wird die Methode der Untersuchung anhand eines entsprechenden Codes oder alternativ mit einem Freitext angegeben." /> <mustSupport value="true" /> </element> <element id="Observation.method.coding"> <path value="Observation.method.coding" /> <slicing> <discriminator> <type value="value" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed"> <path value="Observation.method.coding" /> <sliceName value="snomed" /> <definition value="Hier wird die Methode der Untersuchung als entsprechender SNOMED CT®-Code angegeben." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-method-snomed-ct-vs" /> </binding> </element> <element id="Observation.method.coding:snomed.system"> <path value="Observation.method.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed.version"> <path value="Observation.method.coding.version" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed.code"> <path value="Observation.method.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.coding:snomed.display"> <path value="Observation.method.coding.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Observation.method.text"> <path value="Observation.method.text" /> <definition value="Hier wird ein Freitext eingetragen." /> <mustSupport value="true" /> </element> <element id="Observation.hasMember"> <path value="Observation.hasMember" /> <definition value="Hier kann der zu einer vorliegenden Schwangerschaft gehörende geschätzte Entbindungstermin referenziert werden." /> <comment value="EPAObservationEstimatedDateOfDelivery" /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" /> </type> <mustSupport value="true" /> </element> <element id="Observation.hasMember.reference"> <path value="Observation.hasMember.reference" /> <min value="1" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-observation-pregnancy-status", "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status", "version": "1.1.0", "name": "EPAObservationPregnancyStatus", "title": "EPA Pregnancy Status Observation Profile", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "mio42 GmbH", "description": "In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Observation", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Observation", "derivation": "constraint", "differential": { "element": [ { "id": "Observation", "path": "Observation", "definition": "In diesem Profil kann dokumentiert werden ob bei der versicherten Person eine Schwangerschaft besteht.", "constraint": [ { "key": "obs-epa-1", "severity": "error", "human": "At least year, month and day are needed", "expression": "(effective as dateTime).toString().length() >= 10", "source": "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" }, { "key": "obs-epa-2", "severity": "error", "human": "If it is a valid Observation it must have a value otherwise it must not have a value", "expression": "(Observation.value.exists() implies (Observation.status in ('final' | 'amended' | 'corrected' | 'preliminary')))", "source": "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" } ] }, { "id": "Observation.meta", "path": "Observation.meta", "mustSupport": true }, { "id": "Observation.meta.versionId", "path": "Observation.meta.versionId", "mustSupport": true }, { "id": "Observation.meta.lastUpdated", "path": "Observation.meta.lastUpdated", "mustSupport": true }, { "id": "Observation.text", "path": "Observation.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": "Observation.text.status", "path": "Observation.text.status", "patternCode": "extensions" }, { "id": "Observation.status", "path": "Observation.status", "definition": "Hier wird ein Code aus dem FHIR ValueSet http://hl7.org/fhir/ValueSet/observation-status angegeben.", "mustSupport": true }, { "id": "Observation.code", "path": "Observation.code", "definition": "Die Codes in diesem Abschnitt beschreiben das Konzept \"Schwangerschaftsstatus\".", "mustSupport": true }, { "id": "Observation.code.coding", "path": "Observation.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc", "path": "Observation.code.coding", "sliceName": "loinc", "definition": "Der Code in diesem Abschnitt beschreibt das Konzept \"Schwangerschaftsstatus\".", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-loinc-vs" } }, { "id": "Observation.code.coding:loinc.system", "path": "Observation.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc.version", "path": "Observation.code.coding.version", "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc.code", "path": "Observation.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Observation.code.coding:loinc.display", "path": "Observation.code.coding.display", "min": 1, "mustSupport": true }, { "id": "Observation.subject", "path": "Observation.subject", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "mustSupport": true }, { "id": "Observation.subject.identifier", "path": "Observation.subject.identifier", "min": 1, "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-kvid-10" ] } ], "mustSupport": true }, { "id": "Observation.effective[x]", "path": "Observation.effective[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "closed" }, "definition": "Zeitpunkt, an dem die Untersuchung durchgeführt wurde.", "min": 1, "type": [ { "code": "dateTime" } ], "mustSupport": true }, { "id": "Observation.effective[x]:effectiveDateTime", "path": "Observation.effective[x]", "sliceName": "effectiveDateTime", "definition": "Zeitpunkt, an dem die Untersuchung durchgeführt wurde.", "min": 1, "max": "1", "type": [ { "code": "dateTime" } ], "mustSupport": true }, { "id": "Observation.performer", "path": "Observation.performer", "definition": "Hier wird die behandelnde Person/Einrichtung referenziert, die die Beobachtung durchgeführt hat.", "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] } ], "mustSupport": true }, { "id": "Observation.performer.reference", "path": "Observation.performer.reference", "mustSupport": true }, { "id": "Observation.performer.identifier", "path": "Observation.performer.identifier", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-kvid-10", "http://fhir.de/StructureDefinition/identifier-telematik-id" ] } ], "mustSupport": true }, { "id": "Observation.value[x]", "path": "Observation.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "closed" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept", "path": "Observation.value[x]", "sliceName": "valueCodeableConcept", "definition": "Hier wird angeben, ob eine Schwangerschaft vorliegt.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding", "path": "Observation.value[x].coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc", "path": "Observation.value[x].coding", "sliceName": "loinc", "definition": "Hier wird das Ergebnis als LOINC®-Code aus einem vorgegebenen Valueset angegeben.", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-value-loinc-vs" } }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.system", "path": "Observation.value[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.version", "path": "Observation.value[x].coding.version", "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.code", "path": "Observation.value[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Observation.value[x]:valueCodeableConcept.coding:loinc.display", "path": "Observation.value[x].coding.display", "min": 1, "mustSupport": true }, { "id": "Observation.note", "path": "Observation.note", "definition": "Hier können ergänzende freitextliche Kommentare und Notizen vorgenommen werden, die nicht durch die strukturierten Datenelemente erfassbar sind.", "mustSupport": true }, { "id": "Observation.note.author[x]", "path": "Observation.note.author[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "rules": "closed" }, "definition": "Hier wird die Person 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": "Observation.note.author[x]:authorReference", "path": "Observation.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": "Observation.note.author[x]:authorReference.reference", "path": "Observation.note.author[x].reference", "mustSupport": true }, { "id": "Observation.note.author[x]:authorReference.identifier", "path": "Observation.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": "Observation.note.time", "path": "Observation.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": "Observation.note.text", "path": "Observation.note.text", "definition": "Hier wird der eigentliche Text der Notiz eingetragen.", "mustSupport": true }, { "id": "Observation.method", "path": "Observation.method", "definition": "Hier wird die Methode der Untersuchung anhand eines entsprechenden Codes oder alternativ mit einem Freitext angegeben.", "mustSupport": true }, { "id": "Observation.method.coding", "path": "Observation.method.coding", "slicing": { "discriminator": [ { "type": "value", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed", "path": "Observation.method.coding", "sliceName": "snomed", "definition": "Hier wird die Methode der Untersuchung als entsprechender SNOMED CT®-Code angegeben.", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-pregnancy-status-method-snomed-ct-vs" } }, { "id": "Observation.method.coding:snomed.system", "path": "Observation.method.coding.system", "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed.version", "path": "Observation.method.coding.version", "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed.code", "path": "Observation.method.coding.code", "min": 1, "mustSupport": true }, { "id": "Observation.method.coding:snomed.display", "path": "Observation.method.coding.display", "min": 1, "mustSupport": true }, { "id": "Observation.method.text", "path": "Observation.method.text", "definition": "Hier wird ein Freitext eingetragen.", "mustSupport": true }, { "id": "Observation.hasMember", "path": "Observation.hasMember", "definition": "Hier kann der zu einer vorliegenden Schwangerschaft gehörende geschätzte Entbindungstermin referenziert werden.", "comment": "EPAObservationEstimatedDateOfDelivery", "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ], "mustSupport": true }, { "id": "Observation.hasMember.reference", "path": "Observation.hasMember.reference", "min": 1, "mustSupport": true } ] } }
Informationsmodell als LogicalModel
Das Profil basiert auf folgendem Informationsmodell:
Schwangerschaftsstatus (schwangerschaftsstatus) | http://hl7.org/fhir/StructureDefinition/Base | ||
durchfuehrendePersonReferenz | 0..1 | BackboneElement | |
behandelndePersonVzdFhirDirectory | 0..1 | Reference() | |
behandelndePersonEinrichtung | 0..1 | Reference() | |
einrichtungVzdFhirDirectory | 0..1 | Reference() | |
kontaktperson | 0..1 | Reference() | |
patientInEpa | 0..1 | Reference() | |
status | 1..1 | CodingBinding | |
codeAuswahl | 1..* | BackboneElement | |
loincCode | 1..1 | CodingBinding | |
ergebnisCodeAuswahl | I | 0..* | BackboneElement |
loincCode | 1..1 | CodingBinding | |
zeitpunktDerUntersuchung | 1..1 | dateTime | |
methodeCodeBezeichnung | 0..1 | BackboneElement | |
codeAuswahl | 1..* | BackboneElement | |
snomedCtCode | 1..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
notiz | 0..* | BackboneElement | |
autorReferenz | 0..1 | BackboneElement | |
behandelndePersonVzdFhirDirectory | 0..1 | Reference() | |
einrichtungVzdFhirDirectory | 0..1 | Reference() | |
zeitpunktDerErstellung | 0..1 | dateTime | |
text | 1..1 | string | |
entbindungsterminReferenz | 0..1 | BackboneElement | |
geschaetzterEntbindungstermin | 1..1 | Reference() |
Beispiele
{ "resourceType": "Observation", "id": "45ffea3c-dd06-44ef-adbd-a4741ed064d2", "meta": { "versionId": "1", "lastUpdated": "2025-07-23T16:22:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" ] }, "subject": { "identifier": { "system": "http://fhir.de/sid/gkv/kvid-10", "type": { "coding": [ { "code": "KVZ10", "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "display": "Krankenversichertennummer" } ] }, "value": "X110411319" } }, "code": { "coding": [ { "code": "82810-3", "system": "http://loinc.org", "version": "2.77", "display": "Pregnancy status" } ] }, "status": "final", "effectiveDateTime": "2025-07-23", "valueCodeableConcept": { "coding": [ { "code": "LA26683-5", "system": "http://loinc.org", "version": "2.77", "display": "Not pregnant" } ] } }
<Observation xmlns="http://hl7.org/fhir"> <id value="45ffea3c-dd06-44ef-adbd-a4741ed064d2" /> <meta> <versionId value="1" /> <lastUpdated value="2025-07-23T16:22:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-observation-pregnancy-status" /> </meta> <status value="final" /> <code> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="82810-3" /> <display value="Pregnancy status" /> </coding> </code> <subject> <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> </subject> <effectiveDateTime value="2025-07-23" /> <valueCodeableConcept> <coding> <system value="http://loinc.org" /> <version value="2.77" /> <code value="LA26683-5" /> <display value="Not pregnant" /> </coding> </valueCodeableConcept> </Observation>