This page is part of the Radiation Dose Summary for Diagnostic Procedures on FHIR (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/radiation-dose-summary/StructureDefinition/radiation-dose-summary |
Version: | 0.1.0 |
Name: | RadiationDoseSummary |
Title: | Radiation Dose Summary |
Status: | Draft as of 12/8/21 3:51 PM |
Definition: | General Structure describing a summary of an irradiation act |
Publisher: | HL7 Imaging Integration Working Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/radiation-dose-summary/StructureDefinition/radiation-dose-summary
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
Summary
Mandatory: 8 elements (6 nested mandatory elements)
Must-Support: 12 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | 0..* | Observation | This is an abstract profile 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 |
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] | 0..0 | |||
dataAbsentReason | 0..0 | |||
specimen | 0..0 | |||
device | S | 0..1 | Reference(Modality Device) | Irradiating modality |
Slices for hasMember | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() | |
hasMember:irradiationEvent | S | 0..* | Reference(Irradiation Event Summary) | Related irradiation events. |
Slices for component | S | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
component:All Slices | Content/Rules for all slices | |||
code | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Radiation Dose Summary component type (extensible) | |
component:procedureReported | S | 1..1 | BackboneElement | Related Reported Procedure. |
code | 1..1 | CodeableConcept | Type of component 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://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121058 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Procedure reported | |
Slices for value[x] | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
valueCodeableConcept | 0..1 | CodeableConcept | Actual component result Binding: Procedure Reported Type Value Set (required) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | This is an abstract profile Measurements and simple assertions |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
Slices for 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 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 | |
Slices for 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 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 | |
Slices for 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 | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
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 |
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 | I | 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 | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 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 | |
Slices for hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() |
hasMember:irradiationEvent | SΣ | 0..* | Reference(Irradiation Event Summary) | Related irradiation events. |
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
Slices for component | SΣ | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
component:All Slices | Content/Rules for all slices | |||
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 | I | 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 | |
component:procedureReported | SΣ | 1..1 | BackboneElement | Related Reported Procedure. |
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: 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://dicom.nema.org/resources/ontology/DCM | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121058 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Procedure reported | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Actual component result Binding: Procedure Reported Type Value Set (required) |
dataAbsentReason | I | 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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | This is an abstract profile Measurements and simple assertions |
identifier:radiationSRUID | Σ | 0..* | Identifier | Identifier related to SOP Instance UID if the resource is generated based on an RDSR |
basedOn:serviceRequestRef | Σ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
partOf:imagingStudyRef | Σ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
code | Σ | 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 | Σ | 1..1 | Reference(Patient) | Irradiated patient |
effective[x] | Σ | 1..1 | dateTime | Irradiation Start Date Time |
Slices for performer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation Slice: Unordered, Closed by type:reference |
performer:irradiationAutorizingPerson | Σ | 1..1 | Reference(Practitioner) | Related irradiation authorizing person |
device | 0..1 | Reference(Modality Device) | Irradiating modality | |
hasMember:irradiationEvent | Σ | 0..* | Reference(Irradiation Event Summary) | Related irradiation events. |
Slices for component | Σ | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
component:procedureReported | Σ | 1..1 | BackboneElement | Related Reported Procedure. |
Documentation for this format |
This structure is derived from Observation
Summary
Mandatory: 8 elements (6 nested mandatory elements)
Must-Support: 12 elements
Prohibited: 3 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 | This is an abstract profile 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 |
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] | 0..0 | |||
dataAbsentReason | 0..0 | |||
specimen | 0..0 | |||
device | S | 0..1 | Reference(Modality Device) | Irradiating modality |
Slices for hasMember | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() | |
hasMember:irradiationEvent | S | 0..* | Reference(Irradiation Event Summary) | Related irradiation events. |
Slices for component | S | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
component:All Slices | Content/Rules for all slices | |||
code | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: Radiation Dose Summary component type (extensible) | |
component:procedureReported | S | 1..1 | BackboneElement | Related Reported Procedure. |
code | 1..1 | CodeableConcept | Type of component 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://dicom.nema.org/resources/ontology/DCM | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121058 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Procedure reported | |
Slices for value[x] | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Open by type:$this | |
valueCodeableConcept | 0..1 | CodeableConcept | Actual component result Binding: Procedure Reported Type Value Set (required) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | This is an abstract profile Measurements and simple assertions |
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: 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 | |
Slices for 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 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 | |
Slices for 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 | |
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
reference | ΣI | 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 | |
Slices for 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 | Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record |
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 |
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 | I | 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 | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 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 | |
Slices for hasMember | Σ | 0..* | Reference(Observation | QuestionnaireResponse | MolecularSequence) | Related resource that belongs to the Observation group Slice: Unordered, Open by profile:$this.resolve() |
hasMember:irradiationEvent | SΣ | 0..* | Reference(Irradiation Event Summary) | Related irradiation events. |
derivedFrom | Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from |
Slices for component | SΣ | 1..* | BackboneElement | Component results Slice: Unordered, Open by pattern:code |
component:All Slices | Content/Rules for all slices | |||
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 | I | 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 | |
component:procedureReported | SΣ | 1..1 | BackboneElement | Related Reported Procedure. |
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: 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://dicom.nema.org/resources/ontology/DCM | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121058 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Procedure reported | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
Slices for value[x] | Σ | 0..1 | CodeableConcept | Actual component result Slice: Unordered, Closed by type:$this |
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Actual component result Binding: Procedure Reported Type Value Set (required) |
dataAbsentReason | I | 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 |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Observation.language | preferred | CommonLanguages Max Binding: AllLanguages |
Observation.identifier:radiationSRUID.use | required | IdentifierUse |
Observation.identifier:radiationSRUID.type | extensible | Pattern: sop-instance-uid("SOP Instance UID") |
Observation.basedOn:serviceRequestRef.type | extensible | ResourceType |
Observation.basedOn:serviceRequestRef.identifier.use | required | IdentifierUse |
Observation.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID") |
Observation.partOf:imagingStudyRef.type | extensible | ResourceType |
Observation.partOf:imagingStudyRef.identifier.use | required | IdentifierUse |
Observation.partOf:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID") |
Observation.status | required | ObservationStatus |
Observation.category | preferred | ObservationCategoryCodes |
Observation.code | example | Pattern: LOINC code 73569-6("Radiation exposure and protection information [Description] Document Diagnostic imaging") |
Observation.interpretation | extensible | ObservationInterpretationCodes |
Observation.bodySite | example | SNOMEDCTBodyStructures |
Observation.method | example | ObservationMethods |
Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
Observation.component.code | extensible | ComponentRadiationDoseSummaryVS |
Observation.component.dataAbsentReason | extensible | DataAbsentReason |
Observation.component.interpretation | extensible | ObservationInterpretationCodes |
Observation.component:procedureReported.code | example | Pattern: 121058("Procedure reported") |
Observation.component:procedureReported.value[x]:valueCodeableConcept | required | ProcedureReportedTypeVS |
Observation.component:procedureReported.dataAbsentReason | extensible | DataAbsentReason |
Observation.component:procedureReported.interpretation | extensible | ObservationInterpretationCodes |
Id | Path | Details | Requirements |
obs-3 | Observation.referenceRange | Must have at least a low or a high or text : low.exists() or high.exists() or text.exists() |