Onconova Implementation Guide
0.2.0 - ci-build

Onconova Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Cancer Risk Assessment Profile

Official URL: http://onconova.github.io/fhir/StructureDefinition/onconova-cancer-risk-assessment Version: 0.2.0
Active as of 2026-03-18 Computable Name: OnconovaCancerRiskAssessment

A profile representing a risk assessment performed for a cancer patient, including the method used, the resulting risk level, and an optional numerical score.

It constraints the mCODE CancerRiskAssessment profile and expands the valuesets for cancer risk assessment methods and values.

Conformance:

Observation resources representing a cancer-related risk assessment in the scope of Onconova SHALL conform to this profile. Any resource intended to conform to this profile SHOULD populate meta.profile accordingly.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* CancerRiskAssessment assessment observation
Constraints: obs-6, obs-7, o-ria-req-1, o-ria-req-2, o-ria-req-3, o-ria-req-4
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:riskAssessmentScore O 0..1 decimal, integer Risk Assessment Score
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-risk-assessment-score
ObligationsActor
SHALL:populate-if-known Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Not used in this profile
... status ?!SΣ 1..1 code Not used in this profile
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
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: survey
..... 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
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SOΣ 1..1 CodeableConcept The type of risk assessment information reported.
Binding: Cancer Risk Assessment Methods Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... subject SOΣ 1..1 Reference(Cancer Patient Profile) (USCDI) Who and/or what the observation is about
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... focus SOΣ 0..* Reference(Primary Cancer Condition Profile) The cancer condition associated with risk assessment.
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SOΣ 1..1 dateTime S Date the risk assessment was performed
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Not used in this profile
... value[x] SOΣC 0..1 CodeableConcept S The value of the risk assessment
Binding: Risk Assessment Values Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... dataAbsentReason C 0..1 CodeableConcept Not used in this profile
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept Not used in this profile
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) Not used in this profile
... component Σ 0..* BackboneElement Not used in this profile
.... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📦6.1.0 US Core v6.1
Observation.code Base required Cancer Risk Assessment Methods Value Set 📦0.2.0 This IG
Observation.value[x] Base required Risk Assessment Values Value Set 📦0.2.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
o-ria-req-1 error Observation The subject element is required and must be provided. subject.exists()
o-ria-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
o-ria-req-3 error Observation The code element is required and must be provided. code.exists() and code.coding.exists()
o-ria-req-4 error Observation The valueCodeableConcept element is required and must be provided. valueCodeableConcept.exists() and valueCodeableConcept.coding.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

This structure is derived from CancerRiskAssessment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* CancerRiskAssessment assessment observation
Constraints: o-ria-req-1, o-ria-req-2, o-ria-req-3, o-ria-req-4
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:riskAssessmentScore O 0..1 decimal, integer Risk Assessment Score
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-risk-assessment-score
ObligationsActor
SHALL:populate-if-known Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Not used in this profile
... partOf 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Not used in this profile
... category 1..* CodeableConcept (USCDI) 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: survey
... code O 1..1 CodeableConcept The type of risk assessment information reported.
Binding: Cancer Risk Assessment Methods Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... subject O 1..1 Reference(Cancer Patient Profile) (USCDI) Who and/or what the observation is about
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... focus O 0..* Reference(Primary Cancer Condition Profile) The cancer condition associated with risk assessment.
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... encounter 0..1 Reference(Encounter) Not used in this profile
... effective[x] O 1..1 dateTime Date the risk assessment was performed
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... performer 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Not used in this profile
... value[x] O 0..1 CodeableConcept The value of the risk assessment
Binding: Risk Assessment Values Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... dataAbsentReason 0..1 CodeableConcept Not used in this profile
... interpretation 0..* CodeableConcept Not used in this profile
... hasMember 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... derivedFrom 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) Not used in this profile
... component 0..* BackboneElement Not used in this profile

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base required Cancer Risk Assessment Methods Value Set 📦0.2.0 This IG
Observation.value[x] Base required Risk Assessment Values Value Set 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
o-ria-req-1 error Observation The subject element is required and must be provided. subject.exists()
o-ria-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
o-ria-req-3 error Observation The code element is required and must be provided. code.exists() and code.coding.exists()
o-ria-req-4 error Observation The valueCodeableConcept element is required and must be provided. valueCodeableConcept.exists() and valueCodeableConcept.coding.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* CancerRiskAssessment assessment observation
Constraints: obs-6, obs-7, o-ria-req-1, o-ria-req-2, o-ria-req-3, o-ria-req-4
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:riskAssessmentScore O 0..1 decimal, integer Risk Assessment Score
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-risk-assessment-score
ObligationsActor
SHALL:populate-if-known Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Not used in this profile
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Not used in this profile
... status ?!SΣ 1..1 code Not used in this profile
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
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: survey
..... 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
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SOΣ 1..1 CodeableConcept The type of risk assessment information reported.
Binding: Cancer Risk Assessment Methods Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... subject SOΣ 1..1 Reference(Cancer Patient Profile) (USCDI) Who and/or what the observation is about
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... focus SOΣ 0..* Reference(Primary Cancer Condition Profile) The cancer condition associated with risk assessment.
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SOΣ 1..1 dateTime S Date the risk assessment was performed
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Not used in this profile
... value[x] SOΣC 0..1 CodeableConcept S The value of the risk assessment
Binding: Risk Assessment Values Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... dataAbsentReason C 0..1 CodeableConcept Not used in this profile
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept Not used in this profile
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.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange C 0..* BackboneElement Not used in this profile
Constraints: obs-3
.... 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) Not used in this profile
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) Not used in this profile
... component Σ 0..* BackboneElement Not used in this profile
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📦6.1.0 US Core v6.1
Observation.code Base required Cancer Risk Assessment Methods Value Set 📦0.2.0 This IG
Observation.value[x] Base required Risk Assessment Values Value Set 📦0.2.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
o-ria-req-1 error Observation The subject element is required and must be provided. subject.exists()
o-ria-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
o-ria-req-3 error Observation The code element is required and must be provided. code.exists() and code.coding.exists()
o-ria-req-4 error Observation The valueCodeableConcept element is required and must be provided. valueCodeableConcept.exists() and valueCodeableConcept.coding.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* CancerRiskAssessment assessment observation
Constraints: obs-6, obs-7, o-ria-req-1, o-ria-req-2, o-ria-req-3, o-ria-req-4
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:riskAssessmentScore O 0..1 decimal, integer Risk Assessment Score
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-risk-assessment-score
ObligationsActor
SHALL:populate-if-known Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Not used in this profile
... status ?!SΣ 1..1 code Not used in this profile
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
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: survey
..... 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
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SOΣ 1..1 CodeableConcept The type of risk assessment information reported.
Binding: Cancer Risk Assessment Methods Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... subject SOΣ 1..1 Reference(Cancer Patient Profile) (USCDI) Who and/or what the observation is about
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... focus SOΣ 0..* Reference(Primary Cancer Condition Profile) The cancer condition associated with risk assessment.
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SOΣ 1..1 dateTime S Date the risk assessment was performed
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Not used in this profile
... value[x] SOΣC 0..1 CodeableConcept S The value of the risk assessment
Binding: Risk Assessment Values Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... dataAbsentReason C 0..1 CodeableConcept Not used in this profile
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept Not used in this profile
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) Not used in this profile
... component Σ 0..* BackboneElement Not used in this profile
.... 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📦6.1.0 US Core v6.1
Observation.code Base required Cancer Risk Assessment Methods Value Set 📦0.2.0 This IG
Observation.value[x] Base required Risk Assessment Values Value Set 📦0.2.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
o-ria-req-1 error Observation The subject element is required and must be provided. subject.exists()
o-ria-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
o-ria-req-3 error Observation The code element is required and must be provided. code.exists() and code.coding.exists()
o-ria-req-4 error Observation The valueCodeableConcept element is required and must be provided. valueCodeableConcept.exists() and valueCodeableConcept.coding.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Differential View

This structure is derived from CancerRiskAssessment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* CancerRiskAssessment assessment observation
Constraints: o-ria-req-1, o-ria-req-2, o-ria-req-3, o-ria-req-4
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:riskAssessmentScore O 0..1 decimal, integer Risk Assessment Score
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-risk-assessment-score
ObligationsActor
SHALL:populate-if-known Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Not used in this profile
... partOf 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Not used in this profile
... category 1..* CodeableConcept (USCDI) 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: survey
... code O 1..1 CodeableConcept The type of risk assessment information reported.
Binding: Cancer Risk Assessment Methods Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... subject O 1..1 Reference(Cancer Patient Profile) (USCDI) Who and/or what the observation is about
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... focus O 0..* Reference(Primary Cancer Condition Profile) The cancer condition associated with risk assessment.
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... encounter 0..1 Reference(Encounter) Not used in this profile
... effective[x] O 1..1 dateTime Date the risk assessment was performed
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... performer 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Not used in this profile
... value[x] O 0..1 CodeableConcept The value of the risk assessment
Binding: Risk Assessment Values Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... dataAbsentReason 0..1 CodeableConcept Not used in this profile
... interpretation 0..* CodeableConcept Not used in this profile
... hasMember 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Not used in this profile
... derivedFrom 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) Not used in this profile
... component 0..* BackboneElement Not used in this profile

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.code Base required Cancer Risk Assessment Methods Value Set 📦0.2.0 This IG
Observation.value[x] Base required Risk Assessment Values Value Set 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
o-ria-req-1 error Observation The subject element is required and must be provided. subject.exists()
o-ria-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
o-ria-req-3 error Observation The code element is required and must be provided. code.exists() and code.coding.exists()
o-ria-req-4 error Observation The valueCodeableConcept element is required and must be provided. valueCodeableConcept.exists() and valueCodeableConcept.coding.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* CancerRiskAssessment assessment observation
Constraints: obs-6, obs-7, o-ria-req-1, o-ria-req-2, o-ria-req-3, o-ria-req-4
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:riskAssessmentScore O 0..1 decimal, integer Risk Assessment Score
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-risk-assessment-score
ObligationsActor
SHALL:populate-if-known Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Not used in this profile
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Not used in this profile
... status ?!SΣ 1..1 code Not used in this profile
Binding: ObservationStatus (required): Codes providing the status of an observation.
... Slices for category S 1..* CodeableConcept (USCDI) Classification of type of observation
Slice: Unordered, Open by pattern:$this
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: survey
..... 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
.... category:us-core S 0..* CodeableConcept (USCDI) Classification of type of observation
Binding: US Core Simple Observation Category (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
... code SOΣ 1..1 CodeableConcept The type of risk assessment information reported.
Binding: Cancer Risk Assessment Methods Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... subject SOΣ 1..1 Reference(Cancer Patient Profile) (USCDI) Who and/or what the observation is about
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... focus SOΣ 0..* Reference(Primary Cancer Condition Profile) The cancer condition associated with risk assessment.
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... encounter Σ 0..1 Reference(Encounter) Not used in this profile
... effective[x] SOΣ 1..1 dateTime S Date the risk assessment was performed
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..* Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core CareTeam Profile | US Core RelatedPerson Profile) Not used in this profile
... value[x] SOΣC 0..1 CodeableConcept S The value of the risk assessment
Binding: Risk Assessment Values Value Set (required)
ObligationsActor
SHALL:populate Creator (Onconova)
SHOULD:persist Consumer (Onconova)
... dataAbsentReason C 0..1 CodeableConcept Not used in this profile
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept Not used in this profile
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.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) Not used in this profile
... referenceRange C 0..* BackboneElement Not used in this profile
Constraints: obs-3
.... 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) Not used in this profile
... derivedFrom Σ 0..* Reference(Observation | US Core DocumentReference Profile | US Core QuestionnaireResponse Profile | ImagingStudy | Media | MolecularSequence) Not used in this profile
... component Σ 0..* BackboneElement Not used in this profile
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Observation.status Base required ObservationStatus 📍4.0.1 FHIR Std.
Observation.category Base preferred Observation Category Codes 📦4.0.1 FHIR Std.
Observation.category:us-core Base required US Core Simple Observation Category 📦6.1.0 US Core v6.1
Observation.code Base required Cancer Risk Assessment Methods Value Set 📦0.2.0 This IG
Observation.value[x] Base required Risk Assessment Values Value Set 📦0.2.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📦4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📦4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📦4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📦4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📦4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Observation If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
o-ria-req-1 error Observation The subject element is required and must be provided. subject.exists()
o-ria-req-2 error Observation The effectiveDateTime element is required and must be provided. effectiveDateTime.exists() and effectiveDateTime.hasValue()
o-ria-req-3 error Observation The code element is required and must be provided. code.exists() and code.coding.exists()
o-ria-req-4 error Observation The valueCodeableConcept element is required and must be provided. valueCodeableConcept.exists() and valueCodeableConcept.coding.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

 

Other representations of profile: CSV, Excel, Schematron