At-Home In-Vitro Test Report, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/home-lab-report/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/DiagnosticReport-at-home-in-vitro-results-covid | Version: 1.1.0 | |||
Active as of 2024-08-08 | Computable Name: DiagnosticReportAtHomeInVitroResultsCovid | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.32.42.3 |
This profile further constrains the DiagnosticReport - At-Home In-Vitro Results profile to COVID-19 At-Home In-Vitro Tests.
This is an example of a profile that is based on a framework profile and futher constrained to meet the requirements of the COVID-19 use case. It is based on the DiagnosticReport - At-Home In-Vitro Results profile.
It constrains the following elements:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReportAtHomeInVitroResult
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReportAtHomeInVitroResult | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
result | 1..1 | Reference(Observation - At-Home In-Vitro Test Result - COVID-19) | Observation representing the result of the at-home in-vitro test. | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | C | 0..* | DiagnosticReportAtHomeInVitroResult | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' |
id | SΣ | 0..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Extension-at-home-in-vitro-test-supporting-info | S | 0..* | (Complex) | Extension - At-Home In-Vitro Test Supporting Information URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-supporting-info |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifier for report |
status | ?!SΣC | 1..1 | code | (USCDI) registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) Fixed Value: final |
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Service category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
category:LaboratorySlice | SΣ | 1..1 | CodeableConcept | (USCDI) Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. 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://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |
code | SΣ | 1..1 | CodeableConcept | Consult LIVD: https://www.cdc.gov/csels/dls/livd-codes.html to obtain the values to be used for each particular use case. Binding: US Core Laboratory Test Codes (extensible): LOINC codes |
subject | SΣ | 1..1 | Reference(Patient - At Home In Vitro Test) | (USCDI) The subject of the report - usually, but not always, the patient |
effective[x] | SΣC | 0..1 | dateTime | (USCDI) Diagnostically relevant time (typically the time of specimen collection) |
issued | SΣC | 0..1 | instant | (USCDI) When the report was released |
performer | SΣ | 0..* | Reference(US Core Practitioner Profile) | (USCDI) Responsible Diagnostic Service |
result | S | 1..1 | Reference(Observation - At-Home In-Vitro Test Result - COVID-19) | Observation representing the result of the at-home in-vitro test. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
DiagnosticReport.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/diagnostic-report-status from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.category:LaboratorySlice | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DiagnosticReport | C | 0..* | DiagnosticReportAtHomeInVitroResult | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' | ||||
id | SΣ | 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-at-home-in-vitro-test-supporting-info | S | 0..* | (Complex) | Extension - At-Home In-Vitro Test Supporting Information URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-supporting-info | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifier for report | ||||
basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||
status | ?!SΣC | 1..1 | code | (USCDI) registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) Fixed Value: final | ||||
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Service category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
category:LaboratorySlice | SΣ | 1..1 | CodeableConcept | (USCDI) Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. 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://terminology.hl7.org/CodeSystem/v2-0074 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |||||
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 | SΣ | 1..1 | CodeableConcept | Consult LIVD: https://www.cdc.gov/csels/dls/livd-codes.html to obtain the values to be used for each particular use case. Binding: US Core Laboratory Test Codes (extensible): LOINC codes | ||||
subject | SΣ | 1..1 | Reference(Patient - At Home In Vitro Test) | (USCDI) 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ΣC | 0..1 | dateTime S | (USCDI) Diagnostically relevant time (typically the time of specimen collection) | ||||
issued | SΣC | 0..1 | instant | (USCDI) When the report was released | ||||
performer | SΣ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core CareTeam Profile | US Core PractitionerRole Profile) | (USCDI) Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
result | S | 1..1 | Reference(Observation - At-Home In-Vitro Test Result - COVID-19) | Observation representing the result of the at-home in-vitro test. | ||||
imagingStudy | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
media | Σ | 0..* | BackboneElement | Images related to the test, such as a photo of the test result, images to support proctor interpretation of test results, etc. Not included in V2 IG. | ||||
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 |
Path | Conformance | ValueSet / Code | URI | |||
DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DiagnosticReport.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/diagnostic-report-status from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.category:LaboratorySlice | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from DiagnosticReportAtHomeInVitroResult
Differential View
This structure is derived from DiagnosticReportAtHomeInVitroResult
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | 0..* | DiagnosticReportAtHomeInVitroResult | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | |
result | 1..1 | Reference(Observation - At-Home In-Vitro Test Result - COVID-19) | Observation representing the result of the at-home in-vitro test. | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | C | 0..* | DiagnosticReportAtHomeInVitroResult | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' |
id | SΣ | 0..1 | id | Logical id of this artifact |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Extension-at-home-in-vitro-test-supporting-info | S | 0..* | (Complex) | Extension - At-Home In-Vitro Test Supporting Information URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-supporting-info |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..* | Identifier | Business identifier for report |
status | ?!SΣC | 1..1 | code | (USCDI) registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) Fixed Value: final |
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Service category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
category:LaboratorySlice | SΣ | 1..1 | CodeableConcept | (USCDI) Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. 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://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |
code | SΣ | 1..1 | CodeableConcept | Consult LIVD: https://www.cdc.gov/csels/dls/livd-codes.html to obtain the values to be used for each particular use case. Binding: US Core Laboratory Test Codes (extensible): LOINC codes |
subject | SΣ | 1..1 | Reference(Patient - At Home In Vitro Test) | (USCDI) The subject of the report - usually, but not always, the patient |
effective[x] | SΣC | 0..1 | dateTime | (USCDI) Diagnostically relevant time (typically the time of specimen collection) |
issued | SΣC | 0..1 | instant | (USCDI) When the report was released |
performer | SΣ | 0..* | Reference(US Core Practitioner Profile) | (USCDI) Responsible Diagnostic Service |
result | S | 1..1 | Reference(Observation - At-Home In-Vitro Test Result - COVID-19) | Observation representing the result of the at-home in-vitro test. |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
DiagnosticReport.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/diagnostic-report-status from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.category:LaboratorySlice | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DiagnosticReport | C | 0..* | DiagnosticReportAtHomeInVitroResult | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports us-core-8: effective[x] SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' us-core-9: issued SHALL be present if the status is 'partial', 'preliminary', 'final', 'amended', 'corrected' or 'appended' | ||||
id | SΣ | 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-at-home-in-vitro-test-supporting-info | S | 0..* | (Complex) | Extension - At-Home In-Vitro Test Supporting Information URL: http://hl7.org/fhir/us/home-lab-report/StructureDefinition/Extension-at-home-in-vitro-test-supporting-info | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business identifier for report | ||||
basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||
status | ?!SΣC | 1..1 | code | (USCDI) registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required) Fixed Value: final | ||||
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Service category Slice: Unordered, Open by pattern:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
category:LaboratorySlice | SΣ | 1..1 | CodeableConcept | (USCDI) Service category Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. 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://terminology.hl7.org/CodeSystem/v2-0074 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |||||
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 | SΣ | 1..1 | CodeableConcept | Consult LIVD: https://www.cdc.gov/csels/dls/livd-codes.html to obtain the values to be used for each particular use case. Binding: US Core Laboratory Test Codes (extensible): LOINC codes | ||||
subject | SΣ | 1..1 | Reference(Patient - At Home In Vitro Test) | (USCDI) 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ΣC | 0..1 | dateTime S | (USCDI) Diagnostically relevant time (typically the time of specimen collection) | ||||
issued | SΣC | 0..1 | instant | (USCDI) When the report was released | ||||
performer | SΣ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core CareTeam Profile | US Core PractitionerRole Profile) | (USCDI) Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
result | S | 1..1 | Reference(Observation - At-Home In-Vitro Test Result - COVID-19) | Observation representing the result of the at-home in-vitro test. | ||||
imagingStudy | 0..* | Reference(ImagingStudy) | Reference to full details of imaging associated with the diagnostic report | |||||
media | Σ | 0..* | BackboneElement | Images related to the test, such as a photo of the test result, images to support proctor interpretation of test results, etc. Not included in V2 IG. | ||||
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 |
Path | Conformance | ValueSet / Code | URI | |||
DiagnosticReport.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DiagnosticReport.status | required | Fixed Value: finalhttp://hl7.org/fhir/ValueSet/diagnostic-report-status from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.category:LaboratorySlice | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | extensible | USCoreLaboratoryTestCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-laboratory-test-codes | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard |
This structure is derived from DiagnosticReportAtHomeInVitroResult
Other representations of profile: CSV, Excel, Schematron