KenyaDiagnosticsFHIRIG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: KenyaDiagnosticReport
| Official URL: http://fhir.nphl.go.ke/StructureDefinition/KenyaDiagnosticReport | Version: 0.1.0 | |||
| Draft as of 2024-11-27 | Computable Name: KenyaDiagnosticReport | |||
This profile defines a diagnostic report to be used in a laboratory test.
Usage:
- Refer to this Resource Profile: KenyaDiagnosticServiceRequest
- Examples for this Resource Profile: DiagnosticReport/example-cbc-diagnostic-report and DiagnosticReport/example-vl-hiv-diagnostic-report
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
  identifier |
S | 1..* | Identifier | Unique identifier for the diagnostic report |
 basedOn |
0..* | Reference(KenyaDiagnosticServiceRequest) | What was requested | |
| status |
S | 1..1 | code | registered | partial | preliminary | final + |
| category |
S | 0..1 | CodeableConcept | Service category |
| code |
S | 1..1 | CodeableConcept | Name/Code for this diagnostic report |
| subject |
S | 1..1 | Reference(Patient (IPS)) | The subject of the report - usually, but not always, the patient |
| effective[x] |
S | 1..1 | dateTime, Period | Date/time this report was prepared |
| performer |
S | 1..1 | Reference(KenyaHealthProviderOrganization) | Responsible Diagnostic Service |
| specimen |
S | 1..1 | Reference(KenyaSpecimen) | Specimens this report is based on |
 result |
0..* | Reference(KenyaObservation) | Observations | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 1..* | Identifier | Unique identifier for the diagnostic report |
| basedOn |
0..* | Reference(KenyaDiagnosticServiceRequest) | What was requested | |
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
| category |
SΣ | 0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
| code |
SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. |
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | The subject of the report - usually, but not always, the patient |
  effective[x] |
SΣ | 1..1 | Date/time this report was prepared | |
 effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| performer |
SΣ | 1..1 | Reference(KenyaHealthProviderOrganization) | Responsible Diagnostic Service |
| specimen |
S | 1..1 | Reference(KenyaSpecimen) | Specimens this report is based on |
| result |
0..* | Reference(KenyaObservation) | Observations | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | |
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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().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 | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | Unique identifier for the diagnostic report | ||||
| basedOn |
0..* | Reference(KenyaDiagnosticServiceRequest) | What was requested | |||||
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| category |
SΣ | 0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | ||||
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | The subject of the report - usually, but not always, the patient | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
| effective[x] |
SΣ | 1..1 | Date/time this report was prepared | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
Σ | 0..1 | instant | DateTime this version was made | ||||
| performer |
SΣ | 1..1 | Reference(KenyaHealthProviderOrganization) | Responsible Diagnostic Service | ||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen |
S | 1..1 | Reference(KenyaSpecimen) | Specimens this report is based on | ||||
| result |
0..* | Reference(KenyaObservation) | Observations | |||||
| imagingStudy |
0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
| media |
Σ | 0..* | BackboneElement | Key images 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 (e.g. explanation) | |||||
| link |
Σ | 1..1 | Reference(Media) | Reference to the image source | ||||
| conclusion |
0..1 | string | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm |
0..* | Attachment | Entire report as issued | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | ||||
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codesfrom the FHIR Standard | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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().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 | 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: 5 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
- KenyaDiagnosticServiceRequest (http://fhir.nphl.go.ke/StructureDefinition/KenyaDiagnosticServiceRequest)
- Patient (IPS) (http://fhir.nphl.go.ke/StructureDefinition/Kenya-patient-ips)
- KenyaHealthProviderOrganization (http://fhir.nphl.go.ke/StructureDefinition/KenyaHealthProviderOrganization)
- KenyaSpecimen (http://fhir.nphl.go.ke/StructureDefinition/KenyaSpecimen)
- KenyaObservation (http://fhir.nphl.go.ke/StructureDefinition/KenyaObservation)
Differential View
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| identifier |
S | 1..* | Identifier | Unique identifier for the diagnostic report |
| basedOn |
0..* | Reference(KenyaDiagnosticServiceRequest) | What was requested | |
| status |
S | 1..1 | code | registered | partial | preliminary | final + |
| category |
S | 0..1 | CodeableConcept | Service category |
| code |
S | 1..1 | CodeableConcept | Name/Code for this diagnostic report |
| subject |
S | 1..1 | Reference(Patient (IPS)) | The subject of the report - usually, but not always, the patient |
| effective[x] |
S | 1..1 | dateTime, Period | Date/time this report was prepared |
| performer |
S | 1..1 | Reference(KenyaHealthProviderOrganization) | Responsible Diagnostic Service |
| specimen |
S | 1..1 | Reference(KenyaSpecimen) | Specimens this report is based on |
| result |
0..* | Reference(KenyaObservation) | Observations | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | Unique identifier for the diagnostic report |
| basedOn |
0..* | Reference(KenyaDiagnosticServiceRequest) | What was requested | |
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
| category |
SΣ | 0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
| code |
SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. |
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | The subject of the report - usually, but not always, the patient |
| effective[x] |
SΣ | 1..1 | Date/time this report was prepared | |
| effectiveDateTime |
dateTime | |||
| effectivePeriod |
Period | |||
| performer |
SΣ | 1..1 | Reference(KenyaHealthProviderOrganization) | Responsible Diagnostic Service |
| specimen |
S | 1..1 | Reference(KenyaSpecimen) | Specimens this report is based on |
| result |
0..* | Reference(KenyaObservation) | Observations | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | |
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codesfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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().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 | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| DiagnosticReport |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..* | Identifier | Unique identifier for the diagnostic report | ||||
| basedOn |
0..* | Reference(KenyaDiagnosticServiceRequest) | What was requested | |||||
| status |
?!SΣ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
| category |
SΣ | 0..1 | CodeableConcept | Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
| code |
SΣ | 1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. | ||||
| subject |
SΣ | 1..1 | Reference(Patient (IPS)) | The subject of the report - usually, but not always, the patient | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
| effective[x] |
SΣ | 1..1 | Date/time this report was prepared | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| issued |
Σ | 0..1 | instant | DateTime this version was made | ||||
| performer |
SΣ | 1..1 | Reference(KenyaHealthProviderOrganization) | Responsible Diagnostic Service | ||||
| resultsInterpreter |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
| specimen |
S | 1..1 | Reference(KenyaSpecimen) | Specimens this report is based on | ||||
| result |
0..* | Reference(KenyaObservation) | Observations | |||||
| imagingStudy |
0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
| media |
Σ | 0..* | BackboneElement | Key images 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 (e.g. explanation) | |||||
| link |
Σ | 1..1 | Reference(Media) | Reference to the image source | ||||
| conclusion |
0..1 | string | Clinical conclusion (interpretation) of test results | |||||
| conclusionCode |
0..* | CodeableConcept | Codes for the clinical conclusion of test results Binding: SNOMEDCTClinicalFindings (example): Diagnosis codes provided as adjuncts to the report. | |||||
| presentedForm |
0..* | Attachment | Entire report as issued | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | URI | |||
| DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1from the FHIR Standard | ||||
| DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | ||||
| DiagnosticReport.code | preferred | LOINCDiagnosticReportCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/report-codesfrom the FHIR Standard | ||||
| DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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().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 | 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: 5 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
- KenyaDiagnosticServiceRequest (http://fhir.nphl.go.ke/StructureDefinition/KenyaDiagnosticServiceRequest)
- Patient (IPS) (http://fhir.nphl.go.ke/StructureDefinition/Kenya-patient-ips)
- KenyaHealthProviderOrganization (http://fhir.nphl.go.ke/StructureDefinition/KenyaHealthProviderOrganization)
- KenyaSpecimen (http://fhir.nphl.go.ke/StructureDefinition/KenyaSpecimen)
- KenyaObservation (http://fhir.nphl.go.ke/StructureDefinition/KenyaObservation)
Other representations of profile: CSV, Excel, Schematron