STU 2 Ballot

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

D.4.1 StructureDefinition: DAF-core-diagnosticreport

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:

  • Query for lab reports belonging to a Patient
  • Query for all patients who have had a specific lab test or panel available
  • Query for all patients with a lab test or panel issued by a particular provider
Mandatory Data Elements and Terminology

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:

  1. a status
  2. a category code of ‘LAB’
  3. a code (preferably a LOINC code) which tells you what is being measured
  4. a patient
  5. a time indicating when the measurement was taken
  6. a time indicating when the measurement was reported
  7. who issues the report
  8. at least one result (an Observation reference)

Profile specific implementation guidance:

  • Additional codes that translate or map to the DiagnosticReport codes or category codes are allowed. For example:
    • providing both a local system codes and a LOINC code that it map to
    • providing a more specific category codes such as “CH” (chemistry) in addition to the “LAB” category code.
Example: DiagnosticReport-Results Example: example

D.4.1.1 Formal Views of Profile Content

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

Complete Summary of the Mandatory Requirements

  1. One status in DiagnosticReport.status which has an required binding to:
  2. One category in DiagnosticReport.category which must have:
    • a fixed DiagnosticReport.category.coding.system= “http://hl7.org/fhir/DiagnosticReport-category”
    • a fixed DiagnosticReport.category.coding.code= “LAB”
  3. One code in DiagnosticReport.code which has an extensible binding to:
  4. One patient in DiagnosticReport.subject
  5. A date and time in DiagnosticReport.effectiveDateTime or DiagnosticReport.effectivePeriod
  6. A date and time in DiagnosticReport.issued
  7. A practitioner or organization in DiagnosticReport.performer
  8. One or more DiagnosticReport.result
    • DiagnosticReport.result.reference reference the Observation resources that are part of this report.
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*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..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierId for external references to this report
... status ?!S1..1coderegistered | partial | final | corrected | appended | cancelled | entered-in-error
Binding: DiagnosticReportStatus (required)
... category S1..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/DiagnosticReport-category","code":"LAB"}]}
... code S1..1CodeableConceptName/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes (extensible)
... subject S1..1Reference(Profile daf-core-patient)The subject of the report, usually, but not always, the patient
... encounter 0..1Reference(Encounter)Health care event when test ordered
... effective[x] S1..1dateTime, PeriodClinically Relevant time/time-period for report
... issued S1..1instantDateTime this version was released
... performer S1..1Reference(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 S1..*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..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link 1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical Interpretation of test results
... codedDiagnosis 0..*CodeableConceptCodes for the conclusion
Binding: SNOMED CT Clinical Findings (example)
... presentedForm 0..*AttachmentEntire report as issued

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*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..1idLogical id of this artifact
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierId for external references to this report
... status ?!S1..1coderegistered | partial | final | corrected | appended | cancelled | entered-in-error
Binding: DiagnosticReportStatus (required)
... category S1..1CodeableConceptService category
Binding: Diagnostic Service Section Codes (example)
Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/DiagnosticReport-category","code":"LAB"}]}
... code S1..1CodeableConceptName/Code for this diagnostic report
Binding: LOINC Diagnostic Report Codes (extensible)
... subject S1..1Reference(Profile daf-core-patient)The subject of the report, usually, but not always, the patient
... encounter 0..1Reference(Encounter)Health care event when test ordered
... effective[x] S1..1dateTime, PeriodClinically Relevant time/time-period for report
... issued S1..1instantDateTime this version was released
... performer S1..1Reference(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 S1..*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..*BackboneElementKey images associated with this report
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... comment 0..1stringComment about the image (e.g. explanation)
.... link 1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical Interpretation of test results
... codedDiagnosis 0..*CodeableConceptCodes for the conclusion
Binding: SNOMED CT Clinical Findings (example)
... presentedForm 0..*AttachmentEntire report as issued

doco 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

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
DiagnosticReport.languageCommon LanguagesextensibleCommon Languages
DiagnosticReport.statusDiagnosticReportStatusrequiredDiagnosticReportStatus
DiagnosticReport.categoryDiagnostic Service Section CodesexampleDiagnostic Service Section Codes
DiagnosticReport.codeLOINC Diagnostic Report CodesextensibleLOINC Diagnostic Report Codes
DiagnosticReport.codedDiagnosisSNOMED CT Clinical FindingsexampleSNOMED CT Clinical Findings

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4DiagnosticReportIf 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-3DiagnosticReportIf 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))]))
.