Generated Narrative: StructureDefinition ACP-OrganDonationChoiceRegistration Name Flags Card. Type Description & Constraints Observation 0..* Zib GeneralMeasurement(2.0.4) GeneralMeasurement #xD; code 1..1 CodeableConcept Investigation or MeasurementName Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://snomed.info/sct #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: 570801000146104 #xD; subject 1..1 Reference(Patient(1.0.0-alpha1)) Who and/or what this is about #xD; context 0..1 Reference(Encounter(1.0.0-alpha1)) Healthcare event during which this observation is made #xD; effective[x] 0..1 dateTime, Period ResultDateTime #xD; value[x] 0..1 CodeableConcept ResultValue Binding: ACPYesNoUnknownVS (1.0.0-alpha1) (required) #xD; dataAbsentReason 0..1 CodeableConcept Why the result is missing #xD; Documentation for this format
Organ donation choice registration in donor register
Answer, captured in an observation, to the question: 'Is the choice on organ donation recorded in the donor register?' Based on Observation resource.
Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.
Measurements and simple assertions made about a patient, device or other subject.
This profile is used both for the GeneralMeasurement concept and the MeasurementResult concept of HCIM GeneralMeasurement. A GeneralMeasurement can contain mutiple related MeasurementResults. This is implemented using a parent Observation with related child Observations. See the code and related elements.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL NOT contain any narrative
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
If code is the same as a component code then the value element associated with the code SHALL NOT be present
value.empty() or component.code.where( (coding.code = %resource.code.coding.code) and (coding.system = %resource.code.coding.system)).empty()
not(exists(f:*[starts-with(local-name(.), 'value')])) or not(count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0)
dataAbsentReason SHALL only be present if Observation.value[x] is not present
dataAbsentReason.empty() or value.empty()
not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
Keuze orgaandonatie vastgelegd in donorregister? (AlgemeneMeting)
Observation[classCode=OBS, moodCode=EVN]
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
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.
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.
Additional Content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. In order 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.
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.
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. Usually modifier elements provide negation or qualification. In order 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.
A unique identifier assigned to this observation.
Allows observations to be distinguished and referenced.
OBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
A plan, proposal or order that is fulfilled in whole or in part by this event.
Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
registered | preliminary | final | amended +
A ConceptMap (http://nictiz.nl/fhir/ConceptMap/ResultStatusCodelist-to-ObservationStatus) is available that maps ResultStatusCodelist to the ObservationStatus value set.
Need to track the status of individual results. Some results are finalized before the whole report is finalized.
status Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"
unique id for the element within a resource (for internal references)
Provides the specific HCIM code for a FHIR element that has a required binding to a FHIR ValueSet
Defines a more specific coded value for a code or string. Especially useful for FHIR's required ValueSets. These extensions are primarily used on codes bound to a required value set, where you would like to use a more specific code than the codes in the bounded value set.
Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet.
All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
The status of the GeneralMeasurement or MeasurementResult.
A code that classifies the general type of observation being made.
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.
Used for filtering what observations are retrieved and displayed.
Codes for high level observation categories.
.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
A GeneralMeasurement can contain mutiple related MeasurementResults. This is implemented using a parent Observation with related child Observations. The Observation.code element is used to describe the GeneralMeasurement Investigation concept for parent Observations and the MeasurementResult MeasurementName concept for child Observations.
Only one of the two value sets (MeasurementNameCodelist) is bound to this element. TestCodelist is not used. This is not a problem because both value sets contain the same codes, namely all SNOMED CT codes.
Knowing what kind of observation is being made is essential to understanding the observation.
OnderzoekCodelijst or MetingNaamCodelijst
MetingNaam voor Keuze orgaandonatie vastgelegd in donorregister?
< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
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. If the target of the observation is different than the subject, the general extension [observation-focal-subject](http://hl7.org/fhir/STU3/extension-observation-focal-subject.html). may be used. However, the distinction between the patient's own value for an observation versus that of the fetus, or the donor or blood product unit, etc., are often specified in the observation code.
Observations have no value if you don't know who or what they're about.
Healthcare event during which this observation is made
The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
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 or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests).
For some observations it may be important to know the link between an observation and a particular encounter.
inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
Date and if possible the time at which the entire or specific result measurement was carried out.
At least a date should be present unless this observation is a historical report.
Knowing when an observation was deemed true is important to its relevance as well as determining trends.
OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
Who was responsible for asserting the observed value as "true".
May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.
OBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
Optional Extension Element - found in all resources.
Literal reference, Relative, internal or absolute URL
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.
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.
Logical reference, when literal reference is not known
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Organ donation choice recorded in donor register.
Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. This element has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueRange, valueRatio, valueSampledData, valueAttachment, valueTime, valueDateTime, or valuePeriod. (The name format is "'value' + the type name" with a capital on the first letter of the type). If the data element is usually coded or if the type associated with the Observation.value defines a coded value, use CodeableConcept instead of string datatype even if the value is uncoded text. A value set is bound to the ValueCodeableConcept element. For further discussion and examples see the [notes section](http://hl7.org/fhir/STU3/observation.html#notes) below.
An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations.
Keuze orgaandonatie in donorregister (UitslagWaarde)
Event.notDone, Event.notDoneReason (maps to valeu[x] or dataAbsentReason)
Provides a reason why the expected value in the element Observation.value[x] is missing.
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.
For many results it is necessary to handle exceptional values in measurements.
Codes specifying why the result (Observation.value[x]) is missing.
The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.
Codes identifying interpretations of observations.
Comments such as an interpretation or advice accompanying the result.
Need to be able to provide free text additional information.
NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
Indicates the site on the subject's body where the observation was made (i.e. the target site).
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[ body-site-instance](http://hl7.org/fhir/STU3/extension-body-site-instance.html).
Codes describing anatomical locations. May include laterality.
The test method used to obtain the result.
Only used if not implicit in code for Observation.code.
In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.
The specimen that was used when this observation was made.
Should only be used if not implicit in code found in `Observation.code`. Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).
The device used to generate the observation data.
An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either an extension or through the Observation.related element.
Guidance on how to interpret the value by comparison to a normal or recommended range.
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 may 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.
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.
Must have at least a low or a high or text
low.exists() or high.exists() or text.exists()
(exists(f:low) or exists(f:high)or exists(f:text))
outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
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).
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).
Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed.
Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc, - for proper interpretation.
Code for the meaning of a reference range.
< 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
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.
This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed.
Need to be able to identify the target population for proper interpretation.
Codes identifying the population the reference range applies to.
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.
Text based reference range in an observation
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'.
Reference to related MeasurementResults belonging to the GeneralMeasurement.
The HCIM GeneralMeasurement (parent) links to every MeasurementResult (child) through the `related.target` reference. The referenced Observation contains all the concepts of the HCIM MeasurementResult container, e.g. results with the name, result value, method, etc. This GeneralMeasurement profile is used for both Observations.
Normally, an observation will have either a value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and a set of related observations or sometimes a QuestionnaireResponse from which the measure is derived.
Relationships established by OBX-4 usage
has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
A code specifying the kind of relationship that exists with the target resource.
The related type will mostly likely be: 'has-member'.
Codes specifying how two observations are related.
A reference to the observation or [QuestionnaireResponse](http://hl7.org/fhir/STU3/questionnaireresponse.html#) resource that is related to this observation.
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.
For a discussion on the ways Observations can be assembled in groups together see [Notes](http://hl7.org/fhir/STU3/observation.html#notes) below.
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.
Type of component observation (code / type)
Describes what was observed. Sometimes this is called the observation "code".
Codes identifying names of simple observations.
The information determined as a result of making the observation, if the information has a simple value.
Normally, an observation will have either a single value or a set of related observations. A few observations (e.g. Apgar score) may have both a value and related observations (for an Apgar score, the observations from which the measure is 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 boolean values use valueCodeableConcept and select codes from <http://hl7.org/fhir/ValueSet/v2-0136> (these "yes/no" concepts can be mapped to the display name "true/false" or other mutually exclusive terms that may be needed"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (the name format is "'value' + the type name" with a capital on the first letter of the type).
363714003 |Interprets| < 441742003 |Evaluation finding|
"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.
The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element.
Provides guide for interpretation of component result