Argo CGM Write
0.1.0 - ci-build
Argo CGM Write, published by Argonaut. 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/argonautproject/cgm/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/uv/cgm/StructureDefinition/cgm-summary-pdf | Version: 0.1.0 | |||
Draft as of 2024-05-23 | Computable Name: CGMSummaryPDF |
A PDF report containing a summary of continuous glucose monitoring (CGM) data.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DiagnosticReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | DiagnosticReport | This profile also complies with the profile US Core DiagnosticReport Profile for Laboratory Results Reporting | ||
Slices for category | 1..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this | |
category:labCategory | S | 1..1 | CodeableConcept | Lab 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://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |
code | 1..1 | CodeableConcept | Code for CGM Summary report 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://hl7.org/uv/cgm/CodeSystem/cgm-summary-codes-temporary | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cgm-summary | |
subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Patient for the report |
Slices for effective[x] | 1..1 | Period | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this | |
effective[x]:effectivePeriod | S | 1..1 | Period | Clinically relevant time/time-period for report |
start | S | 1..1 | dateTime | Start date of the reporting period (YYYY-MM-DD) |
end | S | 1..1 | dateTime | End date of the reporting period (YYYY-MM-DD) |
Slices for result | 0..* | Reference(Observation) | CGM Summary observation Slice: Unordered, Open by value:resolve().code | |
result:cgmSummary | S | 0..* | Reference(CGM Summary Observation) | CGM Summary observation |
Slices for presentedForm | 1..* | Attachment | CGM Summary PDF report Slice: Unordered, Open by value:contentType | |
presentedForm:cgmSummaryPDF | S | 1..* | Attachment | Entire report as issued |
contentType | 1..1 | code | PDF content type Required Pattern: application/pdf | |
data | S | 1..1 | base64Binary | Base64-encoded PDF report data |
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 This profile also complies with the profile US Core DiagnosticReport Profile for Laboratory Results Reporting | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
Slices for category | Σ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
category:labCategory | SΣ | 1..1 | CodeableConcept | Lab 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 | Σ | 1..1 | CodeableConcept | Code for CGM Summary report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. 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://hl7.org/uv/cgm/CodeSystem/cgm-summary-codes-temporary | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cgm-summary | |
subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Patient for the report |
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for report Slice: Unordered, Closed by type:$this |
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period for report |
start | SΣC | 1..1 | dateTime | Start date of the reporting period (YYYY-MM-DD) |
end | SΣC | 1..1 | dateTime | End date of the reporting period (YYYY-MM-DD) |
Slices for result | 0..* | Reference(Observation) | CGM Summary observation Slice: Unordered, Open by value:resolve().code | |
result:cgmSummary | S | 0..* | Reference(CGM Summary Observation) | CGM Summary observation |
Slices for presentedForm | 1..* | Attachment | CGM Summary PDF report Slice: Unordered, Open by value:contentType | |
presentedForm:cgmSummaryPDF | S | 1..* | Attachment | Entire report as issued |
contentType | Σ | 1..1 | code | PDF content type Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf |
data | S | 1..1 | base64Binary | Base64-encoded PDF report data |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.category:labCategory | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | preferred | Pattern: cgm-summaryhttp://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | |
DiagnosticReport.presentedForm:cgmSummaryPDF.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
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 This profile also complies with the profile US Core DiagnosticReport Profile for Laboratory Results Reporting | |||||
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 | Σ | 0..* | Identifier | Business identifier for report | ||||
basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
Slices for category | Σ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
category:labCategory | SΣ | 1..1 | CodeableConcept | Lab 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 | Σ | 1..1 | CodeableConcept | Code for CGM Summary report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. 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://hl7.org/uv/cgm/CodeSystem/cgm-summary-codes-temporary | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cgm-summary | |||||
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 | |||||
subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Patient for the report | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for report Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period for report | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Start date of the reporting period (YYYY-MM-DD) | ||||
end | SΣC | 1..1 | dateTime | End date of the reporting period (YYYY-MM-DD) | ||||
issued | Σ | 0..1 | instant | DateTime this version was made | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
Slices for result | 0..* | Reference(Observation) | CGM Summary observation Slice: Unordered, Open by value:resolve().code | |||||
result:cgmSummary | S | 0..* | Reference(CGM Summary Observation) | CGM Summary observation | ||||
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. | |||||
Slices for presentedForm | 1..* | Attachment | CGM Summary PDF report Slice: Unordered, Open by value:contentType | |||||
presentedForm:cgmSummaryPDF | S | 1..* | Attachment | Entire report as issued | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contentType | Σ | 1..1 | code | PDF content type Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Base64-encoded PDF report data | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
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 | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.category:labCategory | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | preferred | Pattern: cgm-summaryhttp://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
DiagnosticReport.presentedForm:cgmSummaryPDF.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.presentedForm:cgmSummaryPDF.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
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: 11 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from DiagnosticReport
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | DiagnosticReport | This profile also complies with the profile US Core DiagnosticReport Profile for Laboratory Results Reporting | ||
Slices for category | 1..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this | |
category:labCategory | S | 1..1 | CodeableConcept | Lab 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://terminology.hl7.org/CodeSystem/v2-0074 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: LAB | |
code | 1..1 | CodeableConcept | Code for CGM Summary report 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://hl7.org/uv/cgm/CodeSystem/cgm-summary-codes-temporary | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cgm-summary | |
subject | S | 1..1 | Reference(Patient | Group | Device | Location) | Patient for the report |
Slices for effective[x] | 1..1 | Period | Clinically relevant time/time-period for report Slice: Unordered, Open by type:$this | |
effective[x]:effectivePeriod | S | 1..1 | Period | Clinically relevant time/time-period for report |
start | S | 1..1 | dateTime | Start date of the reporting period (YYYY-MM-DD) |
end | S | 1..1 | dateTime | End date of the reporting period (YYYY-MM-DD) |
Slices for result | 0..* | Reference(Observation) | CGM Summary observation Slice: Unordered, Open by value:resolve().code | |
result:cgmSummary | S | 0..* | Reference(CGM Summary Observation) | CGM Summary observation |
Slices for presentedForm | 1..* | Attachment | CGM Summary PDF report Slice: Unordered, Open by value:contentType | |
presentedForm:cgmSummaryPDF | S | 1..* | Attachment | Entire report as issued |
contentType | 1..1 | code | PDF content type Required Pattern: application/pdf | |
data | S | 1..1 | base64Binary | Base64-encoded PDF report data |
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 This profile also complies with the profile US Core DiagnosticReport Profile for Laboratory Results Reporting | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. |
Slices for category | Σ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. |
category:labCategory | SΣ | 1..1 | CodeableConcept | Lab 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 | Σ | 1..1 | CodeableConcept | Code for CGM Summary report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. 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://hl7.org/uv/cgm/CodeSystem/cgm-summary-codes-temporary | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cgm-summary | |
subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Patient for the report |
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for report Slice: Unordered, Closed by type:$this |
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period for report |
start | SΣC | 1..1 | dateTime | Start date of the reporting period (YYYY-MM-DD) |
end | SΣC | 1..1 | dateTime | End date of the reporting period (YYYY-MM-DD) |
Slices for result | 0..* | Reference(Observation) | CGM Summary observation Slice: Unordered, Open by value:resolve().code | |
result:cgmSummary | S | 0..* | Reference(CGM Summary Observation) | CGM Summary observation |
Slices for presentedForm | 1..* | Attachment | CGM Summary PDF report Slice: Unordered, Open by value:contentType | |
presentedForm:cgmSummaryPDF | S | 1..* | Attachment | Entire report as issued |
contentType | Σ | 1..1 | code | PDF content type Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf |
data | S | 1..1 | base64Binary | Base64-encoded PDF report data |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
DiagnosticReport.status | required | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | |
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.category:labCategory | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | |
DiagnosticReport.code | preferred | Pattern: cgm-summaryhttp://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | |
DiagnosticReport.presentedForm:cgmSummaryPDF.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard |
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 This profile also complies with the profile US Core DiagnosticReport Profile for Laboratory Results Reporting | |||||
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 | Σ | 0..* | Identifier | Business identifier for report | ||||
basedOn | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | What was requested | |||||
status | ?!Σ | 1..1 | code | registered | partial | preliminary | final + Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | ||||
Slices for category | Σ | 1..* | CodeableConcept | Service category Slice: Unordered, Open by value:$this Binding: DiagnosticServiceSectionCodes (example): Codes for diagnostic service sections. | ||||
category:labCategory | SΣ | 1..1 | CodeableConcept | Lab 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 | Σ | 1..1 | CodeableConcept | Code for CGM Summary report Binding: LOINCDiagnosticReportCodes (preferred): Codes that describe Diagnostic Reports. 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://hl7.org/uv/cgm/CodeSystem/cgm-summary-codes-temporary | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: cgm-summary | |||||
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 | |||||
subject | SΣ | 1..1 | Reference(Patient | Group | Device | Location) | Patient for the report | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Health care event when test ordered | ||||
Slices for effective[x] | Σ | 1..1 | Period | Clinically relevant time/time-period for report Slice: Unordered, Closed by type:$this | ||||
effective[x]:effectivePeriod | SΣ | 1..1 | Period | Clinically relevant time/time-period for report | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Start date of the reporting period (YYYY-MM-DD) | ||||
end | SΣC | 1..1 | dateTime | End date of the reporting period (YYYY-MM-DD) | ||||
issued | Σ | 0..1 | instant | DateTime this version was made | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Responsible Diagnostic Service | ||||
resultsInterpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam) | Primary result interpreter | ||||
specimen | 0..* | Reference(Specimen) | Specimens this report is based on | |||||
Slices for result | 0..* | Reference(Observation) | CGM Summary observation Slice: Unordered, Open by value:resolve().code | |||||
result:cgmSummary | S | 0..* | Reference(CGM Summary Observation) | CGM Summary observation | ||||
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. | |||||
Slices for presentedForm | 1..* | Attachment | CGM Summary PDF report Slice: Unordered, Open by value:contentType | |||||
presentedForm:cgmSummaryPDF | S | 1..* | Attachment | Entire report as issued | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contentType | Σ | 1..1 | code | PDF content type Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/pdf | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Base64-encoded PDF report data | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
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 | DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.category | example | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.category:labCategory | example | Pattern: LABhttp://hl7.org/fhir/ValueSet/diagnostic-service-sections from the FHIR Standard | ||||
DiagnosticReport.code | preferred | Pattern: cgm-summaryhttp://hl7.org/fhir/ValueSet/report-codes from the FHIR Standard | ||||
DiagnosticReport.conclusionCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
DiagnosticReport.presentedForm:cgmSummaryPDF.contentType | required | Pattern: application/pdfhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
DiagnosticReport.presentedForm:cgmSummaryPDF.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
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: 11 elements
Must-Support: 8 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron