This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions
Laboratory results are grouped and summarized using the DiagnosticReport resource which reference Observation resource(s). Each Observation resource represents an individual laboratory test and result value, a “nested” panel (such as a microbial susceptibility panel) which references other observations, or rarely a laboratory test with component result values. This profile sets minimum expectations for the DiagnosticReport resource to record, search and fetch laboratory results associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the DAF-DiagnosticReport profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each DiagnosticReport must have:
Profile specific implementation guidance:
The official URL for this profile is:
http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-diagnosticreport
This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from DiagnosticReport
DiagnosticReport.status
which has an required binding to:
DiagnosticReport.category
which must have:
DiagnosticReport.category.coding.system
= “http://hl7.org/fhir/DiagnosticReport-category”DiagnosticReport.category.coding.code
= “LAB”DiagnosticReport.code
which has an extensible binding to:
DiagnosticReport.subject
DiagnosticReport.effectiveDateTime
or DiagnosticReport.effectivePeriod
DiagnosticReport.issued
DiagnosticReport.performer
DiagnosticReport.result
DiagnosticReport.result.reference
reference the Observation resources that are part of this report.This structure is derived from DiagnosticReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | 0..* | |||
status | S | 1..1 | code | Binding: DiagnosticReportStatus (required) |
category | S | 1..1 | CodeableConcept | Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/DiagnosticReport-category","code":"LAB"}]} |
code | S | 1..1 | CodeableConcept | Binding: LOINC Diagnostic Report Codes (extensible) |
subject | S | 1..1 | Reference(Profile daf-core-patient) | |
effective[x] | S | 1..1 | dateTime, Period | |
issued | S | 1..1 | instant | |
performer | S | 1..1 | Reference(Profile daf-core-pract | Profile daf-core-organization) | |
result | S | 1..* | Reference(Profile daf-core-resultobs) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | I | 0..* | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | Id for external references to this report |
status | ?!S | 1..1 | code | registered | partial | final | corrected | appended | cancelled | entered-in-error Binding: DiagnosticReportStatus (required) |
category | S | 1..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (example) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/DiagnosticReport-category","code":"LAB"}]} |
code | S | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (extensible) |
subject | S | 1..1 | Reference(Profile daf-core-patient) | The subject of the report, usually, but not always, the patient |
encounter | ∑ | 0..1 | Reference(Encounter) | Health care event when test ordered |
effective[x] | S | 1..1 | dateTime, Period | Clinically Relevant time/time-period for report |
issued | S | 1..1 | instant | DateTime this version was released |
performer | S | 1..1 | Reference(Profile daf-core-pract | Profile daf-core-organization) | Responsible Diagnostic Service |
request | 0..* | Reference(DiagnosticRequest | ProcedureRequest | ReferralRequest) | What was requested | |
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |
result | S | 1..* | Reference(Profile daf-core-resultobs) | Observations - simple, or complex nested groups |
imagingStudy | 0..* | Reference(ImagingStudy | ImagingManifest) | Reference to full details of imaging associated with the diagnostic report | |
image | ∑ | 0..* | BackboneElement | Key images associated with this report |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
comment | 0..1 | string | Comment about the image (e.g. explanation) | |
link | ∑ | 1..1 | Reference(Media) | Reference to the image source |
conclusion | 0..1 | string | Clinical Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: SNOMED CT Clinical Findings (example) | |
presentedForm | 0..* | Attachment | Entire report as issued | |
Documentation for this format |
yet to be done: Xml template
yet to be done: Json template
This structure is derived from DiagnosticReport
Differential View
This structure is derived from DiagnosticReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | 0..* | |||
status | S | 1..1 | code | Binding: DiagnosticReportStatus (required) |
category | S | 1..1 | CodeableConcept | Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/DiagnosticReport-category","code":"LAB"}]} |
code | S | 1..1 | CodeableConcept | Binding: LOINC Diagnostic Report Codes (extensible) |
subject | S | 1..1 | Reference(Profile daf-core-patient) | |
effective[x] | S | 1..1 | dateTime, Period | |
issued | S | 1..1 | instant | |
performer | S | 1..1 | Reference(Profile daf-core-pract | Profile daf-core-organization) | |
result | S | 1..* | Reference(Profile daf-core-resultobs) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | I | 0..* | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | ∑ | 0..* | Identifier | Id for external references to this report |
status | ?!S | 1..1 | code | registered | partial | final | corrected | appended | cancelled | entered-in-error Binding: DiagnosticReportStatus (required) |
category | S | 1..1 | CodeableConcept | Service category Binding: Diagnostic Service Section Codes (example) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/DiagnosticReport-category","code":"LAB"}]} |
code | S | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINC Diagnostic Report Codes (extensible) |
subject | S | 1..1 | Reference(Profile daf-core-patient) | The subject of the report, usually, but not always, the patient |
encounter | ∑ | 0..1 | Reference(Encounter) | Health care event when test ordered |
effective[x] | S | 1..1 | dateTime, Period | Clinically Relevant time/time-period for report |
issued | S | 1..1 | instant | DateTime this version was released |
performer | S | 1..1 | Reference(Profile daf-core-pract | Profile daf-core-organization) | Responsible Diagnostic Service |
request | 0..* | Reference(DiagnosticRequest | ProcedureRequest | ReferralRequest) | What was requested | |
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |
result | S | 1..* | Reference(Profile daf-core-resultobs) | Observations - simple, or complex nested groups |
imagingStudy | 0..* | Reference(ImagingStudy | ImagingManifest) | Reference to full details of imaging associated with the diagnostic report | |
image | ∑ | 0..* | BackboneElement | Key images associated with this report |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
comment | 0..1 | string | Comment about the image (e.g. explanation) | |
link | ∑ | 1..1 | Reference(Media) | Reference to the image source |
conclusion | 0..1 | string | Clinical Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion Binding: SNOMED CT Clinical Findings (example) | |
presentedForm | 0..* | Attachment | Entire report as issued | |
Documentation for this format |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Path | Name | Conformance | ValueSet |
DiagnosticReport.language | Common Languages | extensible | Common Languages |
DiagnosticReport.status | DiagnosticReportStatus | required | DiagnosticReportStatus |
DiagnosticReport.category | Diagnostic Service Section Codes | example | Diagnostic Service Section Codes |
DiagnosticReport.code | LOINC Diagnostic Report Codes | extensible | LOINC Diagnostic Report Codes |
DiagnosticReport.codedDiagnosis | SNOMED CT Clinical Findings | example | SNOMED CT Clinical Findings |
Id | Path | Details | Requirements |
dom-2 | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
dom-3 | DiagnosticReport | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) |