PanCareSurPass Project HL7 FHIR Implementation Guide, published by PanCareSurPass Project. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/pcsp/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/Observation-totalDoseRad-eu-pcsp | Version: 0.2.0 | |||
Draft as of 2024-12-11 | Computable Name: TotalDoseRadObsPcsp |
This profile defines how to represent Radiotherapy Total Dose in FHIR for the purpose of the PanCareSurPass project.
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 | Observation | |||
status | S | 1..1 | code | registered | preliminary | final | amended + |
category | S | 1..* | CodeableConcept | Classification of type of observation 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/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: procedure | |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Radiotherapy Dose Type (required) |
subject | S | 1..1 | Reference(Patient: PCSP) | Who and/or what the observation is about |
Slices for value[x] | S | 1..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
value[x]:valueQuantity | S | 0..1 | Quantity | Actual result |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org |
code | S | 1..1 | code | Coded form of the unit |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Actual result 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/data-absent-reason | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: unknown | |
display | 1..1 | string | Representation defined by the system Fixed Value: Unknown | |
bodySite | 0..1 | CodeableConcept | required for Brachytherapy and External beam Binding: Radiotherapy sites (required) | |
Slices for extension | Content/Rules for all slices | |||
locationQualifier | 0..* | (Complex) | Body Location Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Body Location Qualifier Value Set (required) | |
lateralityQualifier | 0..1 | CodeableConcept | Laterality Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-laterality-qualifier | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.code | required | RadiotherapyDoseTypeVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseType-eu-pcsp from this IG | |
Observation.bodySite | required | VsRadiotherapyhttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapy-pcsp from this IG | |
Observation.bodySite.extension:locationQualifier.value[x] | required | FromToPosteriorAnteriorVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-fromToPosteriorAnterior-eu-pcsp from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children |
category | S | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children 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/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: procedure | |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Radiotherapy Dose Type (required) ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 1..1 | Reference(Patient: PCSP) | Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children |
Slices for value[x] | SΣC | 1..1 | Actual result Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result ele-1: All FHIR elements must have a @value or children |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
unit | SΣ | 0..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children |
system | SΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Required Pattern: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children |
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result ele-1: All FHIR elements must have a @value or children 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/data-absent-reason | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: unknown | |
display | 1..1 | string | Representation defined by the system Fixed Value: Unknown | |
bodySite | 0..1 | CodeableConcept | required for Brachytherapy and External beam Binding: Radiotherapy sites (required) ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
locationQualifier | 0..* | (Complex) | Body Location Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Body Location Qualifier Value Set (required) ele-1: All FHIR elements must have a @value or children | |
lateralityQualifier | 0..1 | CodeableConcept | Laterality Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-laterality-qualifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | Pattern: procedurehttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | required | RadiotherapyDoseTypeVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseType-eu-pcsp from this IG | |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.bodySite | required | VsRadiotherapyhttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapy-pcsp from this IG | |
Observation.bodySite.extension:locationQualifier.value[x] | required | FromToPosteriorAnteriorVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-fromToPosteriorAnterior-eu-pcsp 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 | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | S | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. 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/observation-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: procedure | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Radiotherapy Dose Type (required) | ||||
subject | SΣ | 1..1 | Reference(Patient: PCSP) | Who and/or what the observation is about | ||||
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] | Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 1..1 | Actual result Slice: Unordered, Closed by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 0..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
code | SΣ | 1..1 | code | Coded form of the unit | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result 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/data-absent-reason | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: unknown | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Unknown | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the 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. | |||||
note | 0..* | Annotation | Comments about the observation | |||||
bodySite | 0..1 | CodeableConcept | required for Brachytherapy and External beam Binding: Radiotherapy sites (required) | |||||
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 | |||||
locationQualifier | 0..* | (Complex) | Body Location Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Body Location Qualifier Value Set (required) | |||||
lateralityQualifier | 0..1 | CodeableConcept | Laterality Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-laterality-qualifier | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
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 | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | Pattern: procedurehttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | required | RadiotherapyDoseTypeVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseType-eu-pcsp from this IG | ||||
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | required | VsRadiotherapyhttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapy-pcsp from this IG | ||||
Observation.bodySite.extension:locationQualifier.value[x] | required | FromToPosteriorAnteriorVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-fromToPosteriorAnterior-eu-pcsp from this IG | ||||
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 | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
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: 3 elements(3 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | Observation | |||
status | S | 1..1 | code | registered | preliminary | final | amended + |
category | S | 1..* | CodeableConcept | Classification of type of observation 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/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: procedure | |
code | S | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Radiotherapy Dose Type (required) |
subject | S | 1..1 | Reference(Patient: PCSP) | Who and/or what the observation is about |
Slices for value[x] | S | 1..1 | Actual result Slice: Unordered, Open by type:$this | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
value[x]:valueQuantity | S | 0..1 | Quantity | Actual result |
value | S | 1..1 | decimal | Numerical value (with implicit precision) |
unit | S | 0..1 | string | Unit representation |
system | S | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org |
code | S | 1..1 | code | Coded form of the unit |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Actual result 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/data-absent-reason | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: unknown | |
display | 1..1 | string | Representation defined by the system Fixed Value: Unknown | |
bodySite | 0..1 | CodeableConcept | required for Brachytherapy and External beam Binding: Radiotherapy sites (required) | |
Slices for extension | Content/Rules for all slices | |||
locationQualifier | 0..* | (Complex) | Body Location Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Body Location Qualifier Value Set (required) | |
lateralityQualifier | 0..1 | CodeableConcept | Laterality Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-laterality-qualifier | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Observation.code | required | RadiotherapyDoseTypeVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseType-eu-pcsp from this IG | |
Observation.bodySite | required | VsRadiotherapyhttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapy-pcsp from this IG | |
Observation.bodySite.extension:locationQualifier.value[x] | required | FromToPosteriorAnteriorVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-fromToPosteriorAnterior-eu-pcsp from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | C | 0..* | Observation | Measurements and simple assertions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. ele-1: All FHIR elements must have a @value or children |
category | S | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. ele-1: All FHIR elements must have a @value or children 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/observation-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: procedure | |
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Radiotherapy Dose Type (required) ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 1..1 | Reference(Patient: PCSP) | Who and/or what the observation is about ele-1: All FHIR elements must have a @value or children |
Slices for value[x] | SΣC | 1..1 | Actual result Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
valueQuantity | Quantity | |||
valueCodeableConcept | CodeableConcept | |||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result ele-1: All FHIR elements must have a @value or children |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children |
unit | SΣ | 0..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children |
system | SΣC | 1..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children Required Pattern: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children |
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result ele-1: All FHIR elements must have a @value or children 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/data-absent-reason | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: unknown | |
display | 1..1 | string | Representation defined by the system Fixed Value: Unknown | |
bodySite | 0..1 | CodeableConcept | required for Brachytherapy and External beam Binding: Radiotherapy sites (required) ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
locationQualifier | 0..* | (Complex) | Body Location Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Body Location Qualifier Value Set (required) ele-1: All FHIR elements must have a @value or children | |
lateralityQualifier | 0..1 | CodeableConcept | Laterality Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-laterality-qualifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | |
Observation.category | preferred | Pattern: procedurehttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | |
Observation.code | required | RadiotherapyDoseTypeVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseType-eu-pcsp from this IG | |
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Observation.bodySite | required | VsRadiotherapyhttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapy-pcsp from this IG | |
Observation.bodySite.extension:locationQualifier.value[x] | required | FromToPosteriorAnteriorVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-fromToPosteriorAnterior-eu-pcsp from this IG |
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 | ||||
identifier | Σ | 0..* | Identifier | Business Identifier for observation | ||||
basedOn | Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
category | S | 1..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. 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/observation-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: procedure | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
code | SΣ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: Radiotherapy Dose Type (required) | ||||
subject | SΣ | 1..1 | Reference(Patient: PCSP) | Who and/or what the observation is about | ||||
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] | Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
effectiveDateTime | dateTime | |||||||
effectivePeriod | Period | |||||||
effectiveTiming | Timing | |||||||
effectiveInstant | instant | |||||||
issued | Σ | 0..1 | instant | Date/Time this version was made available | ||||
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
Slices for value[x] | SΣC | 1..1 | Actual result Slice: Unordered, Closed by type:$this | |||||
valueQuantity | Quantity | |||||||
valueCodeableConcept | CodeableConcept | |||||||
value[x]:valueQuantity | SΣC | 0..1 | Quantity | Actual result | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 0..1 | string | Unit representation | ||||
system | SΣC | 1..1 | uri | System that defines coded unit form Required Pattern: http://unitsofmeasure.org | ||||
code | SΣ | 1..1 | code | Coded form of the unit | ||||
value[x]:valueCodeableConcept | ΣC | 0..1 | CodeableConcept | Actual result 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/data-absent-reason | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: unknown | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Unknown | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
dataAbsentReason | C | 0..1 | CodeableConcept | Why the 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. | |||||
note | 0..* | Annotation | Comments about the observation | |||||
bodySite | 0..1 | CodeableConcept | required for Brachytherapy and External beam Binding: Radiotherapy sites (required) | |||||
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 | |||||
locationQualifier | 0..* | (Complex) | Body Location Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-body-location-qualifier" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Body Location Qualifier Value Set (required) | |||||
lateralityQualifier | 0..1 | CodeableConcept | Laterality Qualifier URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/mcode-laterality-qualifier | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
method | 0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
specimen | 0..1 | Reference(Specimen) | Specimen used for this observation | |||||
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |||||
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: LOINCCodes (example): Codes identifying names of simple observations. | ||||
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 | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1 from the FHIR Standard | ||||
Observation.category | preferred | Pattern: procedurehttp://hl7.org/fhir/ValueSet/observation-category from the FHIR Standard | ||||
Observation.code | required | RadiotherapyDoseTypeVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseType-eu-pcsp from this IG | ||||
Observation.value[x]:valueQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reason from the FHIR Standard | ||||
Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretation from the FHIR Standard | ||||
Observation.bodySite | required | VsRadiotherapyhttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapy-pcsp from this IG | ||||
Observation.bodySite.extension:locationQualifier.value[x] | required | FromToPosteriorAnteriorVshttp://hl7.eu/fhir/ig/pcsp/ValueSet/vs-fromToPosteriorAnterior-eu-pcsp from this IG | ||||
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 | example | LOINCCodes (a valid code from LOINC)http://hl7.org/fhir/ValueSet/observation-codes from the FHIR Standard | ||||
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: 3 elements(3 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron