Botswana FHIR Implementation Guide
1.0.0 - ci-build
Botswana FHIR Implementation Guide
1.0.0 - ci-build
Botswana FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/botswana-hie-fhir-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://moh.bw.org/StructureDefinition/lab-order-diagnostic-report | Version: 1.0.0 | |||
| Active as of 2026-10-13 | Computable Name: LabOrderDiagnosticReport | |||
Represents the results for the lab order.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  DiagnosticReport |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 basedOn |
1..1 | Reference(ServiceRequest - Lab Orders) | What was requested | |
| status |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
  category |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: At least the following | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11502-2 | |
| display |
0..1 | string | Representation defined by the system | |
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: Lab Order Codes (extensible) | |
| text |
1..1 | string | Plain text representation of the concept | |
| subject |
1..1 | Reference(Patient - Botswana Patient) | The subject of the report - usually, but not always, the patient | |
| encounter |
0..1 | Reference(Encounter) | Health care event when test ordered | |
| issued |
1..1 | instant | DateTime this version was made | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Responsible Diagnostic Service | |
| result |
C | 1..* | Reference(Observation - Lab Result) | Observations |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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 DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| basedOn |
1..1 | Reference(ServiceRequest - Lab Orders) | What was requested | |
 category |
1..1 | CodeableConcept | Service category Required Pattern: At least the following | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11502-2 | |
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: Lab Order Codes (extensible) | |
| text |
1..1 | string | Plain text representation of the concept | |
| subject |
1..1 | Reference(Patient - Botswana Patient) | The subject of the report - usually, but not always, the patient | |
| encounter |
0..1 | Reference(Encounter) | Health care event when test ordered | |
| issued |
1..1 | instant | DateTime this version was made | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Responsible Diagnostic Service | |
| result |
1..* | Reference(Observation - Lab Result) | Observations | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1 | ||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business identifier for report | |||||
| basedOn |
1..1 | Reference(ServiceRequest - Lab Orders) | What was requested | |||||
| status |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |||||
| category |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11502-2 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: Lab Order Codes (extensible) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| text |
1..1 | string | Plain text representation of the concept | |||||
| subject |
1..1 | Reference(Patient - Botswana Patient) | The subject of the report - usually, but not always, the patient | |||||
| encounter |
0..1 | Reference(Encounter) | Health care event when test ordered | |||||
 effective[x] |
0..1 | Clinically relevant time/time-period for report | ||||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
1..1 | instant | DateTime this version was made | |||||
| performer |
1..* | Reference(Practitioner | Service Provider) | Responsible Diagnostic Service | |||||
| resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | |||||
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on | |||||
| result |
C | 1..* | Reference(Observation - Lab Result) | Observations | ||||
| note |
0..* | Annotation | Comments about the diagnostic report | |||||
| study |
0..* | Reference(GenomicStudy | ImagingStudy) | Reference to full details of an analysis associated with the diagnostic report | |||||
| supportingInfo |
0..* | BackboneElement | Additional information supporting the diagnostic report | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Supporting information role code Binding: hl7VS-VS-observationType (example): The code value for the role of the supporting information in the diagnostic report. | |||||
| reference |
1..1 | Reference(Procedure | Observation | DiagnosticReport | Citation) | Supporting information reference | |||||
| media |
0..* | BackboneElement | Key images or data associated with this report | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| comment |
0..1 | string | Comment about the image or data (e.g. explanation) | |||||
| link |
1..1 | Reference(DocumentReference) | Reference to the image or data source | |||||
| composition |
C | 0..1 | Reference(Composition) | Reference to a Composition resource for the DiagnosticReport structure | ||||
| conclusion |
0..1 | markdown | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |||||
| presentedForm |
0..* | Attachment | Entire report as issued | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.4 |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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 DiagnosticReport
Summary
Mandatory: 7 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| basedOn |
1..1 | Reference(ServiceRequest - Lab Orders) | What was requested | |
| status |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
| category |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11502-2 | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: Lab Order Codes (extensible) | |
| text |
1..1 | string | Plain text representation of the concept | |
| subject |
1..1 | Reference(Patient - Botswana Patient) | The subject of the report - usually, but not always, the patient | |
| encounter |
0..1 | Reference(Encounter) | Health care event when test ordered | |
| issued |
1..1 | instant | DateTime this version was made | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Responsible Diagnostic Service | |
| result |
C | 1..* | Reference(Observation - Lab Result) | Observations |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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()
|
Differential View
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| basedOn |
1..1 | Reference(ServiceRequest - Lab Orders) | What was requested | |
| category |
1..1 | CodeableConcept | Service category Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11502-2 | |
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: Lab Order Codes (extensible) | |
| text |
1..1 | string | Plain text representation of the concept | |
| subject |
1..1 | Reference(Patient - Botswana Patient) | The subject of the report - usually, but not always, the patient | |
| encounter |
0..1 | Reference(Encounter) | Health care event when test ordered | |
| issued |
1..1 | instant | DateTime this version was made | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Responsible Diagnostic Service | |
| result |
1..* | Reference(Observation - Lab Result) | Observations | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1 | ||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Business identifier for report | |||||
| basedOn |
1..1 | Reference(ServiceRequest - Lab Orders) | What was requested | |||||
| status |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |||||
| category |
1..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 11502-2 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| code |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: Lab Order Codes (extensible) | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| text |
1..1 | string | Plain text representation of the concept | |||||
| subject |
1..1 | Reference(Patient - Botswana Patient) | The subject of the report - usually, but not always, the patient | |||||
| encounter |
0..1 | Reference(Encounter) | Health care event when test ordered | |||||
| effective[x] |
0..1 | Clinically relevant time/time-period for report | ||||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
1..1 | instant | DateTime this version was made | |||||
| performer |
1..* | Reference(Practitioner | Service Provider) | Responsible Diagnostic Service | |||||
| resultsInterpreter |
0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | |||||
| specimen |
0..* | Reference(Specimen) | Specimens this report is based on | |||||
| result |
C | 1..* | Reference(Observation - Lab Result) | Observations | ||||
| note |
0..* | Annotation | Comments about the diagnostic report | |||||
| study |
0..* | Reference(GenomicStudy | ImagingStudy) | Reference to full details of an analysis associated with the diagnostic report | |||||
| supportingInfo |
0..* | BackboneElement | Additional information supporting the diagnostic report | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Supporting information role code Binding: hl7VS-VS-observationType (example): The code value for the role of the supporting information in the diagnostic report. | |||||
| reference |
1..1 | Reference(Procedure | Observation | DiagnosticReport | Citation) | Supporting information reference | |||||
| media |
0..* | BackboneElement | Key images or data associated with this report | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| comment |
0..1 | string | Comment about the image or data (e.g. explanation) | |||||
| link |
1..1 | Reference(DocumentReference) | Reference to the image or data source | |||||
| composition |
C | 0..1 | Reference(Composition) | Reference to a Composition resource for the DiagnosticReport structure | ||||
| conclusion |
0..1 | markdown | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |||||
| presentedForm |
0..* | Attachment | Entire report as issued | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.4 |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` |
composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))
|
| dom-2 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DiagnosticReport | 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 | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | 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 DiagnosticReport
Summary
Mandatory: 7 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron