HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot International flag

HL7 Laboratory Report, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/uv-lab-rep-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Bundle: Laboratory Report

Official URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/Bundle-uv-lab Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: BundleLabReportUv

Clinical document used to represent a Laboratory Report for the scope of the HL7 UV Lab Report project.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Laboratory Report bundle
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
dr-to-comp-link: If the laboratory report bundle contains a Composition resource, the DiagnosticReport SHALL always refer to the composition
one-comp-max: A laboratory report bundle SHALL include a maximum of only one Composition
one-dr: A laboratory report bundle SHALL include one and only one DiagnosticReport
dr-comp-identifier: If one or more DiagnosticReport.identifiers are given, at least one of them SHALL be equal to the Composition.identifier
dr-comp-type: If the laboratory report bundle contains a Composition resource, at least one DiagnosticReport.code.coding and Composition.type.coding SHALL be equal
dr-comp-category: At least one DiagnosticReport.category.coding and Composition.category.coding SHALL be equal
dr-comp-subj: If the laboratory report bundle contains a Composition resource, DiagnosticReport and Composition SHALL have the same subject
dr-comp-enc: DiagnosticReport and Composition SHALL have the same encounter
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... identifier Σ 1..1 Identifier Business identifier for this Laboratory Report
ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: Laboratory Report Bundle Types (required)
ele-1: All FHIR elements must have a @value or children
... Slices for entry ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
ele-1: All FHIR elements must have a @value or children
..... resource Σ 1..1 Resource A resource in the bundle
.... entry:composition ΣC 0..1 BackboneElement Entry in the bundle: Laboratory Report Composition
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 CompositionLabReportUv Laboratory Report composition
.... entry:diagnosticReport ΣC 1..1 BackboneElement Entry in the bundle: Laboratory Report DiagnosticReport
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 DiagnosticReportUvLab Laboratory Report DiagnosticReport
.... entry:patient ΣC 0..1 BackboneElement Entry in the bundle: Patient
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 PatientUvLab, PatientAnimalUvLab Information about an individual or animal receiving health care services
.... entry:observation ΣC 0..* BackboneElement Entry in the bundle: Laboratory Result Observation
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 ObservationResultsUvLab Laboratory result for a simple test or for a panel/study
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle: Laboratory Specimen
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 SpecimenUvLab Laboratory Specimen
.... entry:serviceRequest ΣC 0..* BackboneElement Entry in the bundle: Laboratory ServiceRequest
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 ServiceRequestUvLab Laboratory Order
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle: Organization
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource Σ 0..1 Organization Organization
.... entry:practitioner ΣC 0..* BackboneElement Entry in the bundle: Practitioner
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 PractitionerUvLab A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole ΣC 0..* BackboneElement Entry in the bundle: PractitionerRole
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 PractitionerRoleUvLab Roles/organizations the practitioner is associated with
.... entry:bodyStructure ΣC 0..* BackboneElement Entry in the bundle: BodyStructure
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource 0..1 BodyStructureUvLab Specific and identified anatomical structure
.... entry:encounter ΣC 0..* BackboneElement Entry in the bundle: Encounter
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource Σ 0..1 Encounter A resource in the bundle
.... entry:location ΣC 0..* BackboneElement Entry in the bundle: Location
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource Σ 0..1 Location A resource in the bundle
.... entry:provenance ΣC 0..* BackboneElement Entry in the bundle: Provenance
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource Σ 0..1 Provenance A resource in the bundle
.... entry:coverage ΣC 0..* BackboneElement Entry in the bundle: Coverage
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource Σ 0..1 Coverage A resource in the bundle
.... entry:device ΣC 0..* BackboneElement Entry in the bundle: Device
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
ele-1: All FHIR elements must have a @value or children
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... resource Σ 0..1 Device A resource in the bundle
... signature Σ 0..1 Signature Digital Signature of this report
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.typerequiredLabReportBundleTypesVs
http://hl7.org/fhir/uv/lab-report/ValueSet/reportBundleType-uv-lab
from this IG
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
: entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5errorBundle.entry, Bundle.entry:composition, Bundle.entry:diagnosticReport, Bundle.entry:patient, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:serviceRequest, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:bodyStructure, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:provenance, Bundle.entry:coverage, Bundle.entry:devicemust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
: (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:composition, Bundle.entry:diagnosticReport, Bundle.entry:patient, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:serviceRequest, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:bodyStructure, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:provenance, Bundle.entry:coverage, Bundle.entry:devicefullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dr-comp-categoryerrorBundleAt least one DiagnosticReport.category.coding and Composition.category.coding SHALL be equal
: (entry.resource.ofType(Composition).category.exists() or entry.resource.ofType(DiagnosticReport).category.exists()) implies entry.resource.ofType(Composition).category.coding.intersect(entry.resource.ofType(DiagnosticReport).category.coding).exists()
dr-comp-encerrorBundleDiagnosticReport and Composition SHALL have the same encounter
: ( (entry.resource.ofType(Composition).encounter.empty() and entry.resource.ofType(DiagnosticReport).encounter.empty() ) or entry.resource.ofType(Composition).encounter = entry.resource.ofType(DiagnosticReport).encounter )
dr-comp-identifiererrorBundleIf one or more DiagnosticReport.identifiers are given, at least one of them SHALL be equal to the Composition.identifier
: (entry.resource.ofType(Composition).identifier.exists() or entry.resource.ofType(DiagnosticReport).identifier.exists()) implies entry.resource.ofType(Composition).identifier.intersect(entry.resource.ofType(DiagnosticReport).identifier).exists()
dr-comp-subjerrorBundleIf the laboratory report bundle contains a Composition resource, DiagnosticReport and Composition SHALL have the same subject
: entry.resource.ofType(Composition).exists() implies ( (entry.resource.ofType(Composition).subject.empty() and entry.resource.ofType(DiagnosticReport).subject.empty() ) or entry.resource.ofType(Composition).subject = entry.resource.ofType(DiagnosticReport).subject )
dr-comp-typeerrorBundleIf the laboratory report bundle contains a Composition resource, at least one DiagnosticReport.code.coding and Composition.type.coding SHALL be equal
: entry.resource.ofType(Composition).exists() implies entry.resource.ofType(Composition).type.coding.intersect(entry.resource.ofType(DiagnosticReport).code.coding).exists()
dr-to-comp-linkerrorBundleIf the laboratory report bundle contains a Composition resource, the DiagnosticReport SHALL always refer to the composition
: entry.resource.ofType(Composition).exists() implies (entry.resource.ofType(DiagnosticReport).extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition').value.resolve() is Composition)
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
one-comp-maxerrorBundleA laboratory report bundle SHALL include a maximum of only one Composition
: entry.resource.ofType(Composition).count() <= 1
one-drerrorBundleA laboratory report bundle SHALL include one and only one DiagnosticReport
: entry.resource.ofType(DiagnosticReport).count() = 1

 

Other representations of profile: CSV, Excel, Schematron