Administration
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R4B
R4
R3
| Responsible Owner: Patient Administration Work Group | Standards Status : Informative | Compartments : Patient , Practitioner , RelatedPerson |
Raw
XML
Use
Context
:
Any
(
canonical
form
+
also
see
XML
Format
Specification
)
HLAResult
Newborn
Eldest
Twin
Example
(id
=
"infant-twin-1")
<?xml version="1.0" encoding="UTF-8"?>A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonica l) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(refer ence = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(c anonical) = '#').exists()).not()).trace('unmatched', id).empty() not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:refere nce/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])])) If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time. 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 might 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. This element is labeled 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 can 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 information 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. The platform, methodology and software applied at the time of the genotyping The platform, methodology and software applied at the time of the genotyping. 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). 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. 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](http://hl7.org/f hir/extensibility.html#modifierExtension). Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them Usually assigned by the Information System of the diagnostic service provider (filler id). Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. OBR-51/ for globally unique filler ID - OBR-3 , For non-globally unique filler-id the flller/placer number must be combined with the universal service Id - OBR-2(if present)+OBR-3+OBR-4 Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid statusCode Note: final and amended are distinguished by whether observation is the subject of a ControlAct event of type "revise" A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. OBR-4 (HL7 v2 doesn't provide an easy way to indicate both the ordered test and the performed panel) The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. 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). The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. The practitioner or organization that is responsible for the report's conclusions and interpretations. Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. Need to be able to report information about the collected specimens on which the report is based. [Observations](http://hl7.org/fhir/observation.html) that are part of this diagnostic report. Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). 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. 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. 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 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). 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. 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](http://hl7.org/f hir/extensibility.html#modifierExtension). Modifier extensions are expected to modify the meaning or interpretation of the element that contains them A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion. .inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code="annotation"] .value Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. inboundRelationship[typeCode="SPRT"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767- 8].value (type=ST) One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD) Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. "application/pdf" is recommended as the most reliable and interoperable in this context. The platform, methodology and software applied at the time of the genotyping The platform, methodology and software applied at the time of the genotyping.<Patient xmlns="http://hl7.org/fhir"> <!-- newborn twin example --> <id value="infant-twin-1"/> <!-- The details of the child --> <extension url="http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"> <valueString value="Organa"/> </extension> <identifier> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0203"/> <code value="MR"/> </coding> </type> <system value="http://coruscanthealth.org/main-hospital/patient-identifier"/> <value value="MRN7465737865"/> </identifier> <identifier> <system value="http://new-republic.gov/galactic-citizen-identifier"/> <value value="7465737865"/> </identifier> <name> <use value="official"/> <family value="Solo"/> <given value="Jaina"/> </name> <gender value="female"/> <birthDate value="2017-05-15"> <extension url="http://hl7.org/fhir/StructureDefinition/patient-birthTime"> <valueDateTime value="2017-05-15T17:11:00+01:00"/> </extension> </birthDate> <multipleBirthInteger value="1"/> <contact> <!-- Contact of the patient --> <relationship> <!-- Indicates that the contact is the patient's mother --> <coding> <system value="http://snomed.info/sct"/> <code value="72705000"/> <display value="Mother"/> </coding> <coding> <system value="http://terminology.hl7.org/CodeSystem/v2-0131"/> <code value="N"/> </coding> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode"/> <code value="MTH"/> </coding> </relationship> <name> <use value="maiden"/> <family value="Organa"/> <given value="Leia"/> </name> <telecom> <system value="phone"/> <value value="+31201234567"/> <use value="mobile"/> </telecom> </contact> </StructureDefinitionPatient >
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.
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Nov
1,
2019
09:35+1100.
QA
Page
Wed,
Dec
17,
2025
09:54+0000.
Links:
Search
|
doc2=http%3A%2F%2Fhl7.org%2Ffhir%2FR4
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change