Foundation
This page is part of the FHIR Specification (v1.6.0:
STU
3).
The
current
version
which
supercedes
this
version
is
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions 
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
Content
Examples
Detailed
Descriptions
Mappings
XML
JSON
StructureDefinition:
LDLCholesterol
-
XML
LDLCholesterol
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 lab reports, etc.
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or
a meta.lastUpdated
If the resource is contained in another resource, it SHALL be referred to from elsewhere
in the resource
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
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)
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 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.
Example of current allergies list
@prefix fhir: <http://hl7.org/fhir/> . @prefix loinc: <http://loinc.org/owl#> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .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. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human-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. 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. 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. 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. Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. 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" 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. .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN&quo t;].code 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](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. 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. The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. Knowing when an observation was deemed true is important to its relevance as well as determining trends. The date and time this observation was made available to providers, typically after the results have been reviewed and verified. 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' 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](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. 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 some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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](extension-body-site-instance.html). In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. 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). 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. 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. unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. 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. 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 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. 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. 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). 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. 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. 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 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'. A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code. For a discussion on the ways Observations can assembled in groups together see [Notes below](observation.html#4.20.4). 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. unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. 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. 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 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. 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. The "derived-from" type is the only logical choice when referencing the QuestionnaireAnswe r resource. A reference to the observation or [QuestionnaireResponse](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](observatio n.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. unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. 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. 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 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. 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. 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). An observation exists to have a value, though it may not if it is in error, or if it represents a group of observations. "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 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. The component interpretation applies only to the individual component value. For an overall interpretation all components together use thes Observation.interpretation element. For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. 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. </ StructureDefinition > ®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page Links:# - resource ------------------------------------------------------------------- <http://hl7.org/fhir/List/current-allergies> a fhir:List; fhir:nodeRole fhir:treeRoot; fhir:Resource.id [ fhir:value "current-allergies"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ]; fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>Patient Peter Chalmers, DOB = Dec 25, 1974, MRN = 12345 (Acme Healthcare) has the following allergies</p>\n <ul>\n <li>cashew nut allergenic extract Injectable Product (<b>High</b>)</li>\n <li>Allergenic extract, penicillin (high)</li>\n </ul>\n </div>" ]; fhir:List.status [ fhir:value "current"]; fhir:List.mode [ fhir:value "working"]; fhir:List.title [ fhir:value "Current Allergy List"]; fhir:List.code [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:concept loinc:52472-8; fhir:Coding.system [ fhir:value "http://loinc.org" ]; fhir:Coding.code [ fhir:value "52472-8" ]; fhir:Coding.display [ fhir:value "Allergies and Adverse Drug Reactions" ] ]; fhir:CodeableConcept.text [ fhir:value "Current Allergy List" ] ]; fhir:List.date [ fhir:value "2015-07-14T23:10:23+11:00"^^xsd:dateTime]; fhir:List.source [ fhir:link <http://hl7.org/fhir/Patient/example>; fhir:Reference.reference [ fhir:value "Patient/example" ] ]; fhir:List.orderedBy [ fhir:CodeableConcept.coding [ fhir:index 0; fhir:Coding.system [ fhir:value "http://hl7.org/fhir/list-order" ]; fhir:Coding.code [ fhir:value "entry-date" ] ] ]; fhir:List.entry [ fhir:index 0; fhir:List.entry.item [ fhir:link <http://hl7.org/fhir/AllergyIntolerance/example>; fhir:Reference.reference [ fhir:value "AllergyIntolerance/example" ] ] ], [ fhir:index 1; fhir:List.entry.item [ fhir:link <http://hl7.org/fhir/AllergyIntolerance/medication>; fhir:Reference.reference [ fhir:value "AllergyIntolerance/medication" ] ] ] . <http://hl7.org/fhir/Patient/example> a fhir:Patient . # -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000.
QA Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU2
|
|
Version History
|
Table of Contents
|
Compare to DSTU2
|
|
Propose
a
change
|
Propose a change