HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU Ballot 1

This page is part of the HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE) Release 1 - US Realm | STU1 (v0.9.1: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

LaboratoryReport

 

The official URL for this profile is: 

http://hl7.org/fhir/us/mcode/StructureDefinition/obf-LaboratoryReport

A grouping or summarization of laboratory results, where individual results are typically Observations or nested Observations (panels). This class aligns with US Core DiagnosticReport Profile for Laboratory Results Reporting.

This profile builds on USCoreDiagnosticReportProfileLaboratoryReporting.

This profile was published on Thu Aug 01 00:00:00 EDT 2019 as a active by HL7 International Clinical Interoperability Council.

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Mapping Source

This structure represents the following mapping definition:

obf.LaboratoryReport maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.source
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  Identifier maps to identifier
  BasedOn maps to basedOn
  Status maps to status
  Category maps to category
  ObservationSubjectOfRecord maps to subject
  Code maps to code
  CareContext maps to encounter
  RelevantTime maps to effective[x]
  StatementDateTime maps to issued
  DiagnosticReportPerformer maps to performer
  ResultsInterpreter maps to resultsInterpreter
  Specimen maps to specimen
  LaboratoryObservation maps to result (slice on = $this.resolve().code.coding.code; slice strategy = includes)
  MediaIncluded.CommentOrDescription maps to media.comment
  MediaIncluded.Media maps to media.link
  ConclusionText maps to conclusion
  ConclusionCode maps to conclusionCode
  PresentedForm maps to presentedForm
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport obf-LaboratoryReport
... basedOn Reference(ServiceRequest | US Core MedicationRequest Profile)
... category 1..1
... code Binding: US Core Diagnosticreport Report And Note Codes (extensible)
... subject Reference(obf-Patient)The subject of an observation
... encounter Reference(US Core Encounter Profile)
... performer 0..1Reference(US Core Practitioner Profile | US Core Organization Profile)
... resultsInterpreter 0..1Reference(US Core Practitioner Profile | US Core Organization Profile)
... result Reference(obf-LaboratoryObservation)A coded finding based on a specimen, usually collected from a patient (but possibly from a location)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*obf-LaboratoryReport
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(ServiceRequest | US Core MedicationRequest Profile)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 Diagnosticreport Report And Note Codes (extensible)
... subject SΣ1..1Reference(obf-Patient)The subject of an observation
... encounter Σ0..1Reference(US Core Encounter Profile)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..1Reference(US Core Practitioner Profile | US Core Organization Profile)Responsible Diagnostic Service
... resultsInterpreter Σ0..1Reference(US Core Practitioner Profile | US Core Organization Profile)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result SI0..*Reference(obf-LaboratoryObservation)A coded finding based on a specimen, usually collected from a patient (but possibly from a location)
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

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Mapping Source

This structure represents the following mapping definition:

obf.LaboratoryReport maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab:
  Language maps to language
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.SourceSystem maps to meta.source
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Narrative maps to text
  Identifier maps to identifier
  BasedOn maps to basedOn
  Status maps to status
  Category maps to category
  ObservationSubjectOfRecord maps to subject
  Code maps to code
  CareContext maps to encounter
  RelevantTime maps to effective[x]
  StatementDateTime maps to issued
  DiagnosticReportPerformer maps to performer
  ResultsInterpreter maps to resultsInterpreter
  Specimen maps to specimen
  LaboratoryObservation maps to result (slice on = $this.resolve().code.coding.code; slice strategy = includes)
  MediaIncluded.CommentOrDescription maps to media.comment
  MediaIncluded.Media maps to media.link
  ConclusionText maps to conclusion
  ConclusionCode maps to conclusionCode
  PresentedForm maps to presentedForm

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport obf-LaboratoryReport
... basedOn Reference(ServiceRequest | US Core MedicationRequest Profile)
... category 1..1
... code Binding: US Core Diagnosticreport Report And Note Codes (extensible)
... subject Reference(obf-Patient)The subject of an observation
... encounter Reference(US Core Encounter Profile)
... performer 0..1Reference(US Core Practitioner Profile | US Core Organization Profile)
... resultsInterpreter 0..1Reference(US Core Practitioner Profile | US Core Organization Profile)
... result Reference(obf-LaboratoryObservation)A coded finding based on a specimen, usually collected from a patient (but possibly from a location)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DiagnosticReport I0..*obf-LaboratoryReport
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(ServiceRequest | US Core MedicationRequest Profile)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 Diagnosticreport Report And Note Codes (extensible)
... subject SΣ1..1Reference(obf-Patient)The subject of an observation
... encounter Σ0..1Reference(US Core Encounter Profile)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..1Reference(US Core Practitioner Profile | US Core Organization Profile)Responsible Diagnostic Service
... resultsInterpreter Σ0..1Reference(US Core Practitioner Profile | US Core Organization Profile)Primary result interpreter
... specimen 0..*Reference(Specimen)Specimens this report is based on
... result SI0..*Reference(obf-LaboratoryObservation)A coded finding based on a specimen, usually collected from a patient (but possibly from a location)
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, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet / Code
DiagnosticReport.languagepreferredCommonLanguages
Max Binding: AllLanguages
DiagnosticReport.statusrequiredDiagnosticReportStatus
DiagnosticReport.categoryexampleDiagnosticServiceSectionCodes
DiagnosticReport.category:labexamplePattern: LAB
DiagnosticReport.codeextensibleUSCoreDiagnosticreportReportAndNoteCodes
DiagnosticReport.conclusionCodeexampleSNOMEDCTClinicalFindings

 

Constraints

IdPathDetailsRequirements
dom-2DiagnosticReportIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4DiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3DiagnosticReportIf 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(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6DiagnosticReportA resource should have narrative for robust management
: text.div.exists()
dom-5DiagnosticReportIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
us-core-7DiagnosticReportDiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
: result.exists() or presentedForm.exists()
us-core-7DiagnosticReport.resultDiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
: result.exists() or presentedForm.exists()
ele-1DiagnosticReport.mediaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
us-core-7DiagnosticReport.presentedFormDiagnosticReport.result or DiagnosticReport.presentedForm or both SHALL be present.
: result.exists() or presentedForm.exists()