HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
HL7 Laboratory Report
1.0.0-ballot - STU 1 Ballot
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
| Official URL: http://hl7.org/fhir/uv/lab-report/StructureDefinition/BodyStructure-uv-lab | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Computable Name: BodyStructureUvLab | |||
This profile defines how to represent Body Structure in HL7 FHIR for the purpose of this guide.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from BodyStructure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  BodyStructure |
0..* | BodyStructure | Specific and identified anatomical structure | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   laterality |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality | |
   value[x] |
1..1 | CodeableConcept | Value of extension Binding: Body Structure Laterality (preferred) | |
 morphology |
0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | |
| location |
0..1 | CodeableConcept | Body site Binding: SNOMEDCTBodyStructures (preferred) | |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Structure Qualifier (preferred) | |
 image |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.extension:laterality.value[x] | preferred | LabLateralityVshttp://hl7.org/fhir/uv/lab-report/ValueSet/laterality-uv-labfrom this IG | |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| BodyStructure.locationQualifier | preferred | LabSiteQualifierVshttp://hl7.org/fhir/uv/lab-report/ValueSet/siteQualifier-uv-labfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
0..* | BodyStructure | Specific and identified anatomical structure | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| laterality |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality | |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality" | |
 value[x] |
1..1 | CodeableConcept | Value of extension Binding: Body Structure Laterality (preferred) | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether this record is in active use |
| morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) |
| location |
Σ | 0..1 | CodeableConcept | Body site Binding: SNOMEDCTBodyStructures (preferred) |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Structure Qualifier (preferred) | |
 patient |
Σ | 1..1 | Reference(Patient) | Who this is about |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.extension:laterality.value[x] | preferred | LabLateralityVshttp://hl7.org/fhir/uv/lab-report/ValueSet/laterality-uv-labfrom this IG | |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| BodyStructure.locationQualifier | preferred | LabSiteQualifierVshttp://hl7.org/fhir/uv/lab-report/ValueSet/siteQualifier-uv-labfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | If 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-4 | error | BodyStructure | If 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-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| BodyStructure |
0..* | BodyStructure | Specific and identified anatomical structure | |||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| laterality |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Body Structure Laterality (preferred) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Bodystructure identifier | ||||
| active |
?!Σ | 0..1 | boolean | Whether this record is in active use | ||||
| morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | ||||
| location |
Σ | 0..1 | CodeableConcept | Body site Binding: SNOMEDCTBodyStructures (preferred) | ||||
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Structure Qualifier (preferred) | |||||
| description |
Σ | 0..1 | string | Text description | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who this is about | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| BodyStructure.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| BodyStructure.extension:laterality.value[x] | preferred | LabLateralityVshttp://hl7.org/fhir/uv/lab-report/ValueSet/laterality-uv-labfrom this IG | ||||
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | ||||
| BodyStructure.location | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| BodyStructure.locationQualifier | preferred | LabSiteQualifierVshttp://hl7.org/fhir/uv/lab-report/ValueSet/siteQualifier-uv-labfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | If 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-4 | error | BodyStructure | If 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-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from BodyStructure
Differential View
This structure is derived from BodyStructure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
0..* | BodyStructure | Specific and identified anatomical structure | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| laterality |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Body Structure Laterality (preferred) | |
| morphology |
0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | |
| location |
0..1 | CodeableConcept | Body site Binding: SNOMEDCTBodyStructures (preferred) | |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Structure Qualifier (preferred) | |
| image |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.extension:laterality.value[x] | preferred | LabLateralityVshttp://hl7.org/fhir/uv/lab-report/ValueSet/laterality-uv-labfrom this IG | |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| BodyStructure.locationQualifier | preferred | LabSiteQualifierVshttp://hl7.org/fhir/uv/lab-report/ValueSet/siteQualifier-uv-labfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| BodyStructure |
0..* | BodyStructure | Specific and identified anatomical structure | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| laterality |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Body Structure Laterality (preferred) | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether this record is in active use |
| morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) |
| location |
Σ | 0..1 | CodeableConcept | Body site Binding: SNOMEDCTBodyStructures (preferred) |
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Structure Qualifier (preferred) | |
| patient |
Σ | 1..1 | Reference(Patient) | Who this is about |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| BodyStructure.extension:laterality.value[x] | preferred | LabLateralityVshttp://hl7.org/fhir/uv/lab-report/ValueSet/laterality-uv-labfrom this IG | |
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | |
| BodyStructure.location | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| BodyStructure.locationQualifier | preferred | LabSiteQualifierVshttp://hl7.org/fhir/uv/lab-report/ValueSet/siteQualifier-uv-labfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | If 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-4 | error | BodyStructure | If 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-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| BodyStructure |
0..* | BodyStructure | Specific and identified anatomical structure | |||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| laterality |
0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-BodyStructure.includedStructure.laterality" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: Body Structure Laterality (preferred) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Bodystructure identifier | ||||
| active |
?!Σ | 0..1 | boolean | Whether this record is in active use | ||||
| morphology |
Σ | 0..1 | CodeableConcept | Kind of Structure Binding: SNOMEDCTMorphologicAbnormalities (preferred) | ||||
| location |
Σ | 0..1 | CodeableConcept | Body site Binding: SNOMEDCTBodyStructures (preferred) | ||||
| locationQualifier |
0..* | CodeableConcept | Body site modifier Binding: Body Structure Qualifier (preferred) | |||||
| description |
Σ | 0..1 | string | Text description | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who this is about | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| BodyStructure.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| BodyStructure.extension:laterality.value[x] | preferred | LabLateralityVshttp://hl7.org/fhir/uv/lab-report/ValueSet/laterality-uv-labfrom this IG | ||||
| BodyStructure.morphology | preferred | SNOMEDCTMorphologicAbnormalitieshttp://hl7.org/fhir/ValueSet/bodystructure-codefrom the FHIR Standard | ||||
| BodyStructure.location | preferred | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| BodyStructure.locationQualifier | preferred | LabSiteQualifierVshttp://hl7.org/fhir/uv/lab-report/ValueSet/siteQualifier-uv-labfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | BodyStructure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | BodyStructure | If 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-4 | error | BodyStructure | If 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-5 | error | BodyStructure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | BodyStructure | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from BodyStructure
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Orders and Observations. Package hl7.fhir.uv.lab-report#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-10-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change