SIL HIE Implementation Guide
0.1.0 - sil-hie-active
SIL HIE Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions
| Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/hie-diagnosticreport | Version: 0.1.0 | |||
| Active as of 2025-11-25 | Computable Name: HIEDiagnosticReport | |||
R4B DiagnosticReport constrained for HIE capture and exchange.
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for report |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
0..* | HIEReference(ServiceRequest) | What was requested | |
![]() ![]() |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
![]() ![]() |
SΣ | 0..* | HIECodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 |
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Name/Code for this diagnostic report Binding: http://loinc.org (extensible) |
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the report - usually, but not always, the patient |
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Health care event when test ordered |
![]() ![]() |
SΣ | 0..1 | Clinically relevant time/time-period for report | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 0..1 | instant | DateTime this version was made |
![]() ![]() |
SΣ | 1..* | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Responsible Diagnostic Service |
![]() ![]() |
Σ | 0..* | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Primary result interpreter |
![]() ![]() |
0..* | HIEReference(Specimen) | Specimens this report is based on | |
![]() ![]() |
S | 0..* | HIEReference(Observation) | Observations |
![]() ![]() |
0..* | HIEReference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |
![]() ![]() |
1..1 | string | Clinical conclusion (interpretation) of test results | |
![]() ![]() |
0..* | HIECodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | http://loinc.org | Not State | Unknown |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() |
S | 1..* | Identifier | Business identifier for report |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
0..* | HIEReference(ServiceRequest) | What was requested | |
![]() ![]() |
S | 0..* | HIECodeableConcept | Service category |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Name/Code for this diagnostic report Binding: http://loinc.org (extensible) |
![]() ![]() |
S | 1..1 | HIEReference(HIE Patient) | The subject of the report - usually, but not always, the patient |
![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Health care event when test ordered | |
![]() ![]() |
S | 0..1 | dateTime, Period | Clinically relevant time/time-period for report |
![]() ![]() |
S | 0..1 | instant | DateTime this version was made |
![]() ![]() |
S | 1..* | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Responsible Diagnostic Service |
![]() ![]() |
0..* | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Primary result interpreter | |
![]() ![]() |
0..* | HIEReference(Specimen) | Specimens this report is based on | |
![]() ![]() |
S | 0..* | HIEReference(Observation) | Observations |
![]() ![]() |
0..* | HIEReference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIEReference(Media) | Reference to the image source | |
![]() ![]() |
1..1 | string | Clinical conclusion (interpretation) of test results | |
![]() ![]() |
0..* | HIECodeableConcept | Codes for the clinical conclusion of test results | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | http://loinc.org | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for report | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
0..* | HIEReference(ServiceRequest) | What was requested | |||||
![]() ![]() |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
![]() ![]() |
SΣ | 0..* | HIECodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 | ||||
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Name/Code for this diagnostic report Binding: http://loinc.org (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the report - usually, but not always, the patient | ||||
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Health care event when test ordered | ||||
![]() ![]() |
SΣ | 0..1 | Clinically relevant time/time-period for report | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
SΣ | 0..1 | instant | DateTime this version was made | ||||
![]() ![]() |
SΣ | 1..* | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Responsible Diagnostic Service | ||||
![]() ![]() |
Σ | 0..* | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Primary result interpreter | ||||
![]() ![]() |
0..* | HIEReference(Specimen) | Specimens this report is based on | |||||
![]() ![]() |
S | 0..* | HIEReference(Observation) | Observations | ||||
![]() ![]() |
0..* | HIEReference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Key images associated with this report | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Comment about the image (e.g. explanation) | |||||
![]() ![]() ![]() |
Σ | 1..1 | HIEReference(Media) | Reference to the image source | ||||
![]() ![]() |
1..1 | string | Clinical conclusion (interpretation) of test results | |||||
![]() ![]() |
0..* | HIECodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |||||
![]() ![]() |
0..* | Attachment | Entire report as issued | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | http://loinc.org | Not State | Unknown |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | DiagnosticReport.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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: 9 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for report |
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
0..* | HIEReference(ServiceRequest) | What was requested | |
![]() ![]() |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
![]() ![]() |
SΣ | 0..* | HIECodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 |
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Name/Code for this diagnostic report Binding: http://loinc.org (extensible) |
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the report - usually, but not always, the patient |
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Health care event when test ordered |
![]() ![]() |
SΣ | 0..1 | Clinically relevant time/time-period for report | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() |
SΣ | 0..1 | instant | DateTime this version was made |
![]() ![]() |
SΣ | 1..* | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Responsible Diagnostic Service |
![]() ![]() |
Σ | 0..* | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Primary result interpreter |
![]() ![]() |
0..* | HIEReference(Specimen) | Specimens this report is based on | |
![]() ![]() |
S | 0..* | HIEReference(Observation) | Observations |
![]() ![]() |
0..* | HIEReference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |
![]() ![]() |
1..1 | string | Clinical conclusion (interpretation) of test results | |
![]() ![]() |
0..* | HIECodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | http://loinc.org | Not State | Unknown |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
![]() ![]() |
S | 1..* | Identifier | Business identifier for report |
![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() |
1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | |
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
S | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) |
![]() ![]() |
0..* | HIEReference(ServiceRequest) | What was requested | |
![]() ![]() |
S | 0..* | HIECodeableConcept | Service category |
![]() ![]() |
S | 1..1 | HIECodeableConcept | Name/Code for this diagnostic report Binding: http://loinc.org (extensible) |
![]() ![]() |
S | 1..1 | HIEReference(HIE Patient) | The subject of the report - usually, but not always, the patient |
![]() ![]() |
1..1 | HIEReference(HIE Encounter) | Health care event when test ordered | |
![]() ![]() |
S | 0..1 | dateTime, Period | Clinically relevant time/time-period for report |
![]() ![]() |
S | 0..1 | instant | DateTime this version was made |
![]() ![]() |
S | 1..* | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Responsible Diagnostic Service |
![]() ![]() |
0..* | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Primary result interpreter | |
![]() ![]() |
0..* | HIEReference(Specimen) | Specimens this report is based on | |
![]() ![]() |
S | 0..* | HIEReference(Observation) | Observations |
![]() ![]() |
0..* | HIEReference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | HIEReference(Media) | Reference to the image source | |
![]() ![]() |
1..1 | string | Clinical conclusion (interpretation) of test results | |
![]() ![]() |
0..* | HIECodeableConcept | Codes for the clinical conclusion of test results | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | http://loinc.org | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier for report | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | HIECodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | HIEReference(HIE Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
0..* | HIEReference(ServiceRequest) | What was requested | |||||
![]() ![]() |
?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
![]() ![]() |
SΣ | 0..* | HIECodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): HL7 V2 table 0074 | ||||
![]() ![]() |
SΣ | 1..1 | HIECodeableConcept | Name/Code for this diagnostic report Binding: http://loinc.org (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | HIEReference(HIE Patient) | The subject of the report - usually, but not always, the patient | ||||
![]() ![]() |
Σ | 1..1 | HIEReference(HIE Encounter) | Health care event when test ordered | ||||
![]() ![]() |
SΣ | 0..1 | Clinically relevant time/time-period for report | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() |
SΣ | 0..1 | instant | DateTime this version was made | ||||
![]() ![]() |
SΣ | 1..* | HIEReference(HIE Organization | HIE Practitioner | PractitionerRole) | Responsible Diagnostic Service | ||||
![]() ![]() |
Σ | 0..* | HIEReference(HIE Practitioner | PractitionerRole | HIE Organization) | Primary result interpreter | ||||
![]() ![]() |
0..* | HIEReference(Specimen) | Specimens this report is based on | |||||
![]() ![]() |
S | 0..* | HIEReference(Observation) | Observations | ||||
![]() ![]() |
0..* | HIEReference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Key images associated with this report | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Comment about the image (e.g. explanation) | |||||
![]() ![]() ![]() |
Σ | 1..1 | HIEReference(Media) | Reference to the image source | ||||
![]() ![]() |
1..1 | string | Clinical conclusion (interpretation) of test results | |||||
![]() ![]() |
0..* | HIECodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): SNOMED CT Clinical Findings | |||||
![]() ![]() |
0..* | Attachment | Entire report as issued | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.identifier.type | Base | extensible | IdentifierType | 📦4.3.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | DiagnosticReportStatus | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.category | Base | example | Diagnostic Service Section Codes | 📍4.3.0 | FHIR Std. |
| DiagnosticReport.code | Base | extensible | http://loinc.org | Not State | Unknown |
| DiagnosticReport.conclusionCode | Base | example | SNOMED CT Clinical Findings | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | DiagnosticReport.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| 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: 9 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron