Radiation Dose Summary for Diagnostic Procedures on FHIR, published by HL7 International / Imaging Integration. 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/HL7/fhir-radiation-dose-summary-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/radiation-dose-summary/StructureDefinition/radiation-dose-summary | Version: 0.1.0 | |||
Draft as of 2024-07-10 | Computable Name: RadiationDoseSummary |
General Structure describing a summary of an irradiation act
Radiation Dose Summary profile defines an overview of an irradiation act, which can be a irradiating imaging study or a radiopharmaceutical administration. When the Radiation Dose Summary is related to a study, it provides a summary of the irradiation events that occurred within the same procedure and equipment. The Radiation Dose Summary profile has no aim to aggregate radiation exposure over time, or make cumulative calculations over multiple performed procedures. Here is an example of querying a FHIR server hosting Radiation Dose Summary resources:
GET /fhir/Observation?code=73569-6&patient=8&date=gt2020-01-01
For other examples, please refer to the section Radiation Dose Summary Consumer search query samples paragraph, from Test and Conformance page.
Radiation Dose Summary resource can be mapped to the defined CDA section Radiation Exposure and Protection Information from DICOM PS3.20: Imaging Reports using HL7 Clinical Document Architecture.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
Slices for identifier | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:type | |
identifier:radiationSRUID | S | 0..* | Identifier | Identifier related to SOP Instance UID if the resource is generated based on an RDSR |
type | 1..1 | CodeableConcept | Description of identifier 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sop-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: SOP Instance UID | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
value | 1..1 | string | The value that is unique | |
Slices for basedOn | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order Slice: Unordered, Open by type:reference | |
basedOn:serviceRequestRef | S | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
identifier | 0..1 | Identifier | The accession number related to the performed study | |
type | 1..1 | CodeableConcept | Description of identifier 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-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
value | 1..1 | string | The value that is unique | |
Slices for partOf | 1..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event Slice: Unordered, Open by type:reference | |
partOf:imagingStudyRef | S | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
identifier | 0..1 | Identifier | Identifier related to Study Instance UID | |
type | 1..1 | CodeableConcept | Description of identifier 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
value | 1..1 | string | The value that is unique | |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 73569-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiation exposure and protection information [Description] Document Diagnostic imaging | |
subject | S | 1..1 | Reference(Patient) | Irradiated patient |
focus | S | 1..1 | Reference(ImagingStudy) | The observation has a focus on the performed exam. |
effective[x] | S | 1..1 | dateTime | Irradiation Start Date Time |
Slices for performer | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation Slice: Unordered, Closed by type:reference |
performer:irradiationAutorizingPerson | S | 1..1 | Reference(Practitioner) | Related irradiation authorizing person |
value[x] | S | 1..1 | string | Dose Summary text. |
dataAbsentReason | 0..0 | |||
specimen | 0..0 | |||
device | S | 0..1 | Reference(Modality Device) | Irradiating modality |
component | ||||
code | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Radiation Dose Summary component type (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.component.code | extensible | ComponentRadiationDoseSummaryVShttp://hl7.org/fhir/uv/radiation-dose-summary/ValueSet/component-radiation-dose-summary-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:type |
identifier:radiationSRUID | SΣ | 0..* | Identifier | Identifier related to SOP Instance UID if the resource is generated based on an RDSR |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sop-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: SOP Instance UID | |
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
Slices for basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order Slice: Unordered, Open by type:reference |
basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
identifier | Σ | 0..1 | Identifier | The accession number related to the performed study |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
Slices for partOf | Σ | 1..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event Slice: Unordered, Open by type:reference |
partOf:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
identifier | Σ | 0..1 | Identifier | Identifier related to Study Instance UID |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 73569-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiation exposure and protection information [Description] Document Diagnostic imaging | |
subject | SΣ | 1..1 | Reference(Patient) | Irradiated patient |
focus | SΣ | 1..1 | Reference(ImagingStudy) | The observation has a focus on the performed exam. |
effective[x] | SΣ | 1..1 | dateTime | Irradiation Start Date Time |
Slices for performer | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation Slice: Unordered, Closed by type:reference |
performer:irradiationAutorizingPerson | SΣ | 1..1 | Reference(Practitioner) | Related irradiation authorizing person |
value[x] | SΣC | 1..1 | string | Dose Summary text. |
device | S | 0..1 | Reference(Modality Device) | Irradiating modality |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.identifier:radiationSRUID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.identifier:radiationSRUID.type | extensible | Pattern: sop-instance-uid("SOP Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Observation.basedOn:serviceRequestRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Observation.partOf:imagingStudyRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.partOf:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.code | example | Pattern: LOINC Code 73569-6("Radiation exposure and protection information [Description] Document Diagnostic imaging")http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
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 | ||||
Slices for identifier | Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:type | ||||
identifier:radiationSRUID | SΣ | 0..* | Identifier | Identifier related to SOP Instance UID if the resource is generated based on an RDSR | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sop-instance-uid | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: SOP Instance UID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
Slices for basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order Slice: Unordered, Open by type:reference | ||||
basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | The accession number related to the performed study | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
Slices for partOf | Σ | 1..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event Slice: Unordered, Open by type:reference | ||||
partOf:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Identifier related to Study Instance UID | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 73569-6 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Radiation exposure and protection information [Description] Document Diagnostic imaging | |||||
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) | Irradiated patient | ||||
focus | SΣ | 1..1 | Reference(ImagingStudy) | The observation has a focus on the performed exam. | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
effective[x] | SΣ | 1..1 | dateTime | Irradiation Start Date Time | ||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
Slices for performer | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation Slice: Unordered, Closed by type:reference | ||||
performer:irradiationAutorizingPerson | SΣ | 1..1 | Reference(Practitioner) | Related irradiation authorizing person | ||||
value[x] | SΣC | 1..1 | string | Dose Summary text. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
note | 0..* | Annotation | Comments about the observation | |||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
device | S | 0..1 | Reference(Modality Device) | Irradiating modality | ||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
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 | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
age | 0..1 | Range | Applicable age range, if relevant | |||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
component | Σ | 0..* | BackboneElement | Component results | ||||
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 | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Radiation Dose Summary component type (extensible) | ||||
value[x] | Σ | 0..1 | Actual component result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.identifier:radiationSRUID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier:radiationSRUID.type | extensible | Pattern: sop-instance-uid("SOP Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.basedOn:serviceRequestRef.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.basedOn:serviceRequestRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.partOf:imagingStudyRef.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.partOf:imagingStudyRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.partOf:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | example | Pattern: LOINC Code 73569-6("Radiation exposure and protection information [Description] Document Diagnostic imaging")http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | extensible | ComponentRadiationDoseSummaryVShttp://hl7.org/fhir/uv/radiation-dose-summary/ValueSet/component-radiation-dose-summary-vs from this IG | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
This structure is derived from Observation
Summary
Mandatory: 8 elements(6 nested mandatory elements)
Must-Support: 11 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | Measurements and simple assertions | |
Slices for identifier | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:type | |
identifier:radiationSRUID | S | 0..* | Identifier | Identifier related to SOP Instance UID if the resource is generated based on an RDSR |
type | 1..1 | CodeableConcept | Description of identifier 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sop-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: SOP Instance UID | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
value | 1..1 | string | The value that is unique | |
Slices for basedOn | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order Slice: Unordered, Open by type:reference | |
basedOn:serviceRequestRef | S | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
identifier | 0..1 | Identifier | The accession number related to the performed study | |
type | 1..1 | CodeableConcept | Description of identifier 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-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
value | 1..1 | string | The value that is unique | |
Slices for partOf | 1..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event Slice: Unordered, Open by type:reference | |
partOf:imagingStudyRef | S | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
identifier | 0..1 | Identifier | Identifier related to Study Instance UID | |
type | 1..1 | CodeableConcept | Description of identifier 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
value | 1..1 | string | The value that is unique | |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 73569-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiation exposure and protection information [Description] Document Diagnostic imaging | |
subject | S | 1..1 | Reference(Patient) | Irradiated patient |
focus | S | 1..1 | Reference(ImagingStudy) | The observation has a focus on the performed exam. |
effective[x] | S | 1..1 | dateTime | Irradiation Start Date Time |
Slices for performer | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation Slice: Unordered, Closed by type:reference |
performer:irradiationAutorizingPerson | S | 1..1 | Reference(Practitioner) | Related irradiation authorizing person |
value[x] | S | 1..1 | string | Dose Summary text. |
dataAbsentReason | 0..0 | |||
specimen | 0..0 | |||
device | S | 0..1 | Reference(Modality Device) | Irradiating modality |
component | ||||
code | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Radiation Dose Summary component type (extensible) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.component.code | extensible | ComponentRadiationDoseSummaryVShttp://hl7.org/fhir/uv/radiation-dose-summary/ValueSet/component-radiation-dose-summary-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:type |
identifier:radiationSRUID | SΣ | 0..* | Identifier | Identifier related to SOP Instance UID if the resource is generated based on an RDSR |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sop-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: SOP Instance UID | |
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
Slices for basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order Slice: Unordered, Open by type:reference |
basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
identifier | Σ | 0..1 | Identifier | The accession number related to the performed study |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
Slices for partOf | Σ | 1..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event Slice: Unordered, Open by type:reference |
partOf:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
identifier | Σ | 0..1 | Identifier | Identifier related to Study Instance UID |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 73569-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiation exposure and protection information [Description] Document Diagnostic imaging | |
subject | SΣ | 1..1 | Reference(Patient) | Irradiated patient |
focus | SΣ | 1..1 | Reference(ImagingStudy) | The observation has a focus on the performed exam. |
effective[x] | SΣ | 1..1 | dateTime | Irradiation Start Date Time |
Slices for performer | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation Slice: Unordered, Closed by type:reference |
performer:irradiationAutorizingPerson | SΣ | 1..1 | Reference(Practitioner) | Related irradiation authorizing person |
value[x] | SΣC | 1..1 | string | Dose Summary text. |
device | S | 0..1 | Reference(Modality Device) | Irradiating modality |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.identifier:radiationSRUID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.identifier:radiationSRUID.type | extensible | Pattern: sop-instance-uid("SOP Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Observation.basedOn:serviceRequestRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Observation.partOf:imagingStudyRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Observation.partOf:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.code | example | Pattern: LOINC Code 73569-6("Radiation exposure and protection information [Description] Document Diagnostic imaging")http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
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 | ||||
Slices for identifier | Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by pattern:type | ||||
identifier:radiationSRUID | SΣ | 0..* | Identifier | Identifier related to SOP Instance UID if the resource is generated based on an RDSR | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: sop-instance-uid | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: SOP Instance UID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
Slices for basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order Slice: Unordered, Open by type:reference | ||||
basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | The accession number related to the performed study | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
Slices for partOf | Σ | 1..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event Slice: Unordered, Open by type:reference | ||||
partOf:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Identifier related to Study Instance UID | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. 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/fhir/uv/radiation-dose-summary/CodeSystem/dicom-identifier-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
status | ?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | 0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 73569-6 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Radiation exposure and protection information [Description] Document Diagnostic imaging | |||||
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) | Irradiated patient | ||||
focus | SΣ | 1..1 | Reference(ImagingStudy) | The observation has a focus on the performed exam. | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
effective[x] | SΣ | 1..1 | dateTime | Irradiation Start Date Time | ||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
Slices for performer | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation Slice: Unordered, Closed by type:reference | ||||
performer:irradiationAutorizingPerson | SΣ | 1..1 | Reference(Practitioner) | Related irradiation authorizing person | ||||
value[x] | SΣC | 1..1 | string | Dose Summary text. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
note | 0..* | Annotation | Comments about the observation | |||||
bodySite | 0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
device | S | 0..1 | Reference(Modality Device) | Irradiating modality | ||||
referenceRange | C | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text | ||||
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 | ||||
low | C | 0..1 | SimpleQuantity | Low Range, if relevant | ||||
high | C | 0..1 | SimpleQuantity | High Range, if relevant | ||||
type | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. | |||||
appliesTo | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. | |||||
age | 0..1 | Range | Applicable age range, if relevant | |||||
text | 0..1 | string | Text based reference range in an observation | |||||
hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group | ||||
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
component | Σ | 0..* | BackboneElement | Component results | ||||
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 | ||||
code | Σ | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Radiation Dose Summary component type (extensible) | ||||
value[x] | Σ | 0..1 | Actual component result | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueString | string | |||||||
valueBoolean | boolean | |||||||
valueInteger | integer | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueSampledData | SampledData | |||||||
valueTime | time | |||||||
valueDateTime | dateTime | |||||||
valuePeriod | Period | |||||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
interpretation | 0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
referenceRange | 0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Observation.identifier:radiationSRUID.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.identifier:radiationSRUID.type | extensible | Pattern: sop-instance-uid("SOP Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.basedOn:serviceRequestRef.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.basedOn:serviceRequestRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.partOf:imagingStudyRef.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Observation.partOf:imagingStudyRef.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Observation.partOf:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID")http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | example | Pattern: LOINC Code 73569-6("Radiation exposure and protection information [Description] Document Diagnostic imaging")http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methods from the FHIR Standard | ||||
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaning from the FHIR Standard | ||||
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliesto from the FHIR Standard | ||||
Observation.component.code | extensible | ComponentRadiationDoseSummaryVShttp://hl7.org/fhir/uv/radiation-dose-summary/ValueSet/component-radiation-dose-summary-vs from this IG | ||||
Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard |
This structure is derived from Observation
Summary
Mandatory: 8 elements(6 nested mandatory elements)
Must-Support: 11 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron