HL7 FHIR® US Core Implementation Guide STU 3

This page is part of the US Core (v2.1.0: STU3 Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

StructureDefinition-us-core-diagnosticreport-lab

Laboratory results are grouped and summarized using the DiagnosticReport resource which typically reference Observation resource(s). Each Observation resource represents an individual laboratory test and result value or component result values, or a “nested” panel (such as a microbial susceptibility panel) which references other observations. They can also be presented in report form or as free text. 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 US Core DiagnosticReport Profile for Laboratory Results Reporting:

  • Query for lab reports belonging to a Patient
  • Record a lab report for a specific Patient

Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples 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. at least one structured(Observation reference) or unstructured(narrative/text based) result

Each DiagnosticReport must support:

  1. who issues the report

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 to the “LAB” category code, such as “CH” (chemistry), in an additional coding element.
  • Results that are free text or report form are represented using the ‘presentedForm’ element in DiagnosticReport.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab

Published on Tue May 21 00:00:00 EDT 2019 as active by the HL7 US Realm Steering Committee.

This profile builds on DiagnosticReport

DiagnosticReport

Summary of the Mandatory Requirements

  1. A code in DiagnosticReport.status with a required binding to DiagnosticReportStatus
  2. One or more CodeableConcepts CodeableConcept in DiagnosticReport.category with an example binding to Diagnostic Service Section Codes
    • which must have at least a DiagnosticReport.category = {"coding": [{"code": "LAB", "system": "terminology.hl7.org/CodeSystem/v2-0074"}]}
  3. A CodeableConcept in DiagnosticReport.code with an extensible binding to US Core Diagnostic Report Laboratory Codes
  4. A Patient Reference in DiagnosticReport.subject
  5. A dateTime in DiagnosticReport.effective[x]
  6. An instant in DiagnosticReport.issued

Summary of the Must Support Requirements

  1. One or more Performer References in DiagnosticReport.performer
  2. One or more Result References in DiagnosticReport.result with the following constraints: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
  3. One or more Medias in DiagnosticReport.media
  4. One or more Attachments in DiagnosticReport.presentedForm with the following constraints: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.

Summary of Constraints

  1. DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
  2. DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
  3. DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... status S1..1codeBinding: DiagnosticReportStatus (required)
... category SCodeableConceptSlice: Unordered, Open by pattern:$this
... category S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0074","code":"LAB"}]}
... code S1..1CodeableConceptUS Core Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible)
... subject S1..1Reference(US Core Patient Profile)
... effective[x] S1..1dateTime, PeriodSpecimen Collection Datetime or Period
... issued S1..1instant
... performer S0..*Reference(US Core Practitioner Profile | US Core Organization Profile)
... result SI0..*Reference(US Core Laboratory Result Observation Profile)us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... media S0..*BackboneElement
... presentedForm SI0..*Attachmentus-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..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..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!SΣ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category SΣCodeableConceptService category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example)
... category SΣ1..1CodeableConceptService category
Binding: DiagnosticServiceSectionCodes (example)

Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0074","code":"LAB"}]}
... code SΣ1..1CodeableConceptUS Core Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)The subject of the report - usually, but not always, the patient
... encounter Σ0..1Reference(Encounter)Health care event when test ordered
... effective[x] SΣ1..1dateTime, PeriodSpecimen Collection Datetime or Period
... issued SΣ1..1instantDateTime this version was made
... performer SΣ0..*Reference(US Core Practitioner Profile | US Core Organization Profile)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result SI0..*Reference(US Core Laboratory Result Observation Profile)Observations
us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media SΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical conclusion (interpretation) of test results
... conclusionCode 0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example)
... presentedForm SI0..*AttachmentEntire report as issued
us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.

doco Documentation for this format

DiagnosticReport

Summary of the Mandatory Requirements

  1. A code in DiagnosticReport.status with a required binding to DiagnosticReportStatus
  2. One or more CodeableConcepts CodeableConcept in DiagnosticReport.category with an example binding to Diagnostic Service Section Codes
    • which must have at least a DiagnosticReport.category = {"coding": [{"code": "LAB", "system": "terminology.hl7.org/CodeSystem/v2-0074"}]}
  3. A CodeableConcept in DiagnosticReport.code with an extensible binding to US Core Diagnostic Report Laboratory Codes
  4. A Patient Reference in DiagnosticReport.subject
  5. A dateTime in DiagnosticReport.effective[x]
  6. An instant in DiagnosticReport.issued

Summary of the Must Support Requirements

  1. One or more Performer References in DiagnosticReport.performer
  2. One or more Result References in DiagnosticReport.result with the following constraints: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
  3. One or more Medias in DiagnosticReport.media
  4. One or more Attachments in DiagnosticReport.presentedForm with the following constraints: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.

Summary of Constraints

  1. DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
  2. DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
  3. DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... status S1..1codeBinding: DiagnosticReportStatus (required)
... category SCodeableConceptSlice: Unordered, Open by pattern:$this
... category S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0074","code":"LAB"}]}
... code S1..1CodeableConceptUS Core Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible)
... subject S1..1Reference(US Core Patient Profile)
... effective[x] S1..1dateTime, PeriodSpecimen Collection Datetime or Period
... issued S1..1instant
... performer S0..*Reference(US Core Practitioner Profile | US Core Organization Profile)
... result SI0..*Reference(US Core Laboratory Result Observation Profile)us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... media S0..*BackboneElement
... presentedForm SI0..*Attachmentus-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..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..*IdentifierBusiness identifier for report
... basedOn 0..*Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)What was requested
... status ?!SΣ1..1coderegistered | partial | preliminary | final +
Binding: DiagnosticReportStatus (required)
... category SΣCodeableConceptService category
Slice: Unordered, Open by pattern:$this
Binding: DiagnosticServiceSectionCodes (example)
... category SΣ1..1CodeableConceptService category
Binding: DiagnosticServiceSectionCodes (example)

Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0074","code":"LAB"}]}
... code SΣ1..1CodeableConceptUS Core Laboratory Report Order Code
Binding: US Core Diagnostic Report Laboratory Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)The subject of the report - usually, but not always, the patient
... encounter Σ0..1Reference(Encounter)Health care event when test ordered
... effective[x] SΣ1..1dateTime, PeriodSpecimen Collection Datetime or Period
... issued SΣ1..1instantDateTime this version was made
... performer SΣ0..*Reference(US Core Practitioner Profile | US Core Organization Profile)Responsible Diagnostic Service
... resultsInterpreter Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result SI0..*Reference(US Core Laboratory Result Observation Profile)Observations
us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
... imagingStudy 0..*Reference(ImagingStudy)Reference to full details of imaging associated with the diagnostic report
... media SΣI0..*BackboneElementKey images associated with this report
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... comment 0..1stringComment about the image (e.g. explanation)
.... link Σ1..1Reference(Media)Reference to the image source
... conclusion 0..1stringClinical conclusion (interpretation) of test results
... conclusionCode 0..*CodeableConceptCodes for the clinical conclusion of test results
Binding: SNOMEDCTClinicalFindings (example)
... presentedForm SI0..*AttachmentEntire report as issued
us-core-7: DiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Mandatory Search Parameters:

The following search parameters, search parameter combinations and search parameter modifiers, comparators, chains and composites SHALL be supported. the modifiers, comparators, chains and composites that are listed as optional SHOULD be supported.:

  1. SHALL support searching using the combination of the patient and category search parameters:

    GET [base]/DiagnosticReport?patient=[reference]&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB

    Example:

    1. GET [base]/DiagnosticReport?patient=f201&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and a category code = LAB (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and code search parameters:
    • including optional support for composite OR search on code (e.g.code={[system]}|[code],{[system]}|[code],...)

    GET [base]/DiagnosticReport?patient=[reference]&code={[system]}|[code]{,{[system]}|[code],...}

    Example:

    1. GET [base]/DiagnosticReport?patient=1032702&code=http://loinc.org|24323-8

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and report code(s). SHOULD support search by multiple report codes. (how to search by reference and how to search by token)

  3. SHALL support searching using the combination of the patient and category and date search parameters:
    • including support for these date comparators: gt,lt,ge,le
    • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/DiagnosticReport?patient=[reference]&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/DiagnosticReport?patient=f201&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB&date=ge2010-01-14

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and date and a category code = LAB (how to search by reference and how to search by token and how to search by date)

Optional Search Parameters:

The following search parameters, search parameter combinations and search parameter modifiers, comparators, chains and composites SHOULD be supported.

  1. SHOULD support searching using the combination of the patient and status search parameters:

    GET [base]/DiagnosticReport?patient=[reference]&status={[system]}|[code]

    Example:

    1. GET [base]/DiagnosticReport?patient=1137192&status=completed

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and status (how to search by reference and how to search by token)

  2. SHOULD support searching using the combination of the patient and code and date search parameters:

    • including optional support for composite OR search on code (e.g.code={[system]}|[code],{[system]}|[code],...)
    • including support for these date comparators: gt,lt,ge,le
    • including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)

    GET [base]/DiagnosticReport?patient=[reference]&code={[system]}|[code]{,{[system]}|[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/DiagnosticReport?patient=f201&code=http://loinc.org|24323-8&date=ge2019-01-14

    Implementation Notes: Fetches a bundle of all DiagnosticReport resources for the specified patient and date and report code(s). SHOULD support search by multiple report codes. (how to search by reference and how to search by token and how to search by date)