Finnish Base Profiles
0.3.0 - ci-build
Finnish Base Profiles
0.3.0 - ci-build
Finnish Base Profiles - Local Development build (v0.3.0). See the Directory of published versions
| Official URL: http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime | Version: 0.3.0 | |||
| Draft as of 2021-02-22 | Computable Name: FIPHRSDModerateToVigorousPATime | |||
Finnish PHR profile for measured or patient-reported time spent on moderate to vigorous physical activity over a period. At this time weekly (period) and 24h period (dateTime) is coded. The profile is based on the Finnish PHR Fitness profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from FIPHRSDFitness
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | 0..* | FIPHRSDFitness | Finnish PHR Moderate to Vigorous Physical Activity Time profile | |
  meta | 1..1 | Meta | Metadata about the resource | |
  profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
  profile:fiphrProfile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime | |
| code | ||||
  Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
  coding:moderateToVigorousWeeklyMinutes | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a week | |
  system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8 | |
 coding:moderateToVigorousPA24h | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a 24h period | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8-24h | |
| value[x] | 1..1 | Quantity | Actual result | |
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| unit | 1..1 | string | Unit representation Fixed Value: min | |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| code | 1..1 | code | Coded form of the unit Fixed Value: min | |
| component | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | FIPHRSDFitness | Finnish PHR Moderate to Vigorous Physical Activity Time profile |
 meta | Σ | 1..1 | Meta | Metadata about the resource |
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this |
 profile:fiphrProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
| text | N | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| creatingApplication | N | 0..* | (Complex) | Application identification URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication |
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| identifier | ΣN | 1..* | Identifier | Business Identifier for observation |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | Finnish PHR: Status final Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| category | N | 1..1 | CodeableConcept | Classification of type of observation: Binding: Value Set Finnish PHR Fitness Category (extensible): Finnish PHR: Codes for high level observation categories. |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
| coding:fiphrCategory | ΣN | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-fitnesscategory |
| code | Σ | 1..1 | code | Fitness observation category Fixed Value: fitness |
| code | ΣN | 1..1 | CodeableConcept | Type of observation (type / code) Binding: Value Set Finnish PHR Fitness Results (extensible): Codes identifying names of simple observations. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:All Slices | Content/Rules for all slices | |||
 system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| coding:moderateToVigorousWeeklyMinutes | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a week |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8 |
| display | Σ | 1..1 | string | Representation defined by the system |
| coding:moderateToVigorousPA24h | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a 24h period |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8-24h |
| display | Σ | 1..1 | string | Representation defined by the system |
 subject | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who and/or what the observation is about |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
 effective[x] | Σ | 1..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | Σ | 1..1 | instant | Finnish PHR: The date and time this observation is stored. |
| performer | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Finnish PHR: Application user who is responsible for the observation |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| value[x] | ΣC | 1..1 | Quantity | Actual result |
| value | Σ | 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 | Σ | 1..1 | string | Unit representation Fixed Value: min |
| system | ΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: min |
| interpretation | N | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:fiphrInterpretation | ΣN | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| hasMember | ΣCN | 0..1 | Reference(Observation | QuestionnaireResponse) {r} | Related resource that belongs to the Observation group |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.language | required | CommonLanguages |
| Observation.identifier.use | required | IdentifierUse |
| Observation.status | required | Fixed Value: final |
| Observation.category | extensible | fiphr-vs-fitnesscategory (a valid code from Code System Finnish PHR Fitness Category) |
| Observation.code | extensible | fiphr-vs-fitnessresult |
| Observation.value[x].comparator | required | QuantityComparator |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.component.code | extensible | fiphr-vs-fitnessresult |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | Observation.extension:creatingApplication, Observation.modifierExtension, Observation.component.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.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() | |
| qty-3 | error | Observation.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| ref-1 | error | Observation.subject, Observation.performer, Observation.hasMember | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | FIPHRSDFitness | Finnish PHR Moderate to Vigorous Physical Activity Time profile |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
 extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this |
| profile:fiphrProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime |
| security | ΣN | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | ΣN | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
| text | N | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| creatingApplication | N | 0..* | (Complex) | Application identification URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| identifier | ΣN | 1..* | Identifier | Business Identifier for observation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| status | ?!Σ | 1..1 | code | Finnish PHR: Status final Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| category | N | 1..1 | CodeableConcept | Classification of type of observation: Binding: Value Set Finnish PHR Fitness Category (extensible): Finnish PHR: Codes for high level observation categories. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
| coding:fiphrCategory | ΣN | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-fitnesscategory |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Fitness observation category Fixed Value: fitness |
| 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 | ΣN | 1..1 | CodeableConcept | Type of observation (type / code) Binding: Value Set Finnish PHR Fitness Results (extensible): Codes identifying names of simple observations. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:moderateToVigorousWeeklyMinutes | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a week |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8 |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:moderateToVigorousPA24h | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a 24h period |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8-24h |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who and/or what the observation is about |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| display | Σ | 0..1 | string | Text alternative for the resource |
| effective[x] | Σ | 1..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | Σ | 1..1 | instant | Finnish PHR: The date and time this observation is stored. |
| performer | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Finnish PHR: Application user who is responsible for the observation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| display | Σ | 0..1 | string | Text alternative for the resource |
| value[x] | ΣC | 1..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 | Σ | 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 | Σ | 1..1 | string | Unit representation Fixed Value: min |
| system | ΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: min |
| interpretation | N | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:fiphrInterpretation | ΣN | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..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 |
| note | N | 0..* | Annotation | Comments about the observation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
| referenceRange | CN | 0..* | BackboneElement | Provides guide for interpretation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| low | CN | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | CN | 0..1 | SimpleQuantity | High Range, if relevant |
| type | N | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
| appliesTo | N | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. |
| age | CN | 0..1 | Range | Applicable age range, if relevant |
| text | 0..1 | string | Text based reference range in an observation | |
| hasMember | ΣCN | 0..1 | Reference(Observation | QuestionnaireResponse) {r} | Related resource that belongs to the Observation group |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| display | Σ | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.meta.security | extensible | All Security Labels |
| Observation.meta.tag | example | CommonTags |
| Observation.language | required | CommonLanguages |
| Observation.identifier.use | required | IdentifierUse |
| Observation.identifier.type | extensible | Identifier Type Codes |
| Observation.status | required | Fixed Value: final |
| Observation.category | extensible | fiphr-vs-fitnesscategory (a valid code from Code System Finnish PHR Fitness Category) |
| Observation.code | extensible | fiphr-vs-fitnessresult |
| Observation.subject.type | extensible | ResourceType |
| Observation.subject.identifier.use | required | IdentifierUse |
| Observation.subject.identifier.type | extensible | Identifier Type Codes |
| Observation.performer.type | extensible | ResourceType |
| Observation.performer.identifier.use | required | IdentifierUse |
| Observation.performer.identifier.type | extensible | Identifier Type Codes |
| Observation.value[x].comparator | required | QuantityComparator |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
| Observation.hasMember.type | extensible | ResourceType |
| Observation.hasMember.identifier.use | required | IdentifierUse |
| Observation.hasMember.identifier.type | extensible | Identifier Type Codes |
| Observation.component.code | extensible | fiphr-vs-fitnessresult |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Observation.meta.extension, Observation.extension, Observation.extension:creatingApplication, Observation.modifierExtension, Observation.identifier.extension, Observation.category.extension, Observation.category.coding:fiphrCategory.extension, Observation.code.extension, Observation.code.coding.extension, Observation.code.coding:moderateToVigorousWeeklyMinutes.extension, Observation.code.coding:moderateToVigorousPA24h.extension, Observation.subject.extension, Observation.subject.identifier.extension, Observation.performer.extension, Observation.performer.identifier.extension, Observation.value[x].extension, Observation.interpretation.extension, Observation.interpretation.coding:fiphrInterpretation.extension, Observation.note.extension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.hasMember.extension, Observation.hasMember.identifier.extension, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code.extension, Observation.component.code.coding.extension, Observation.component.interpretation.extension, Observation.component.interpretation.coding:fiphrInterpretation.extension | Must have either extensions or value[x], not both : extension.exists() != value.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() | |
| per-1 | error | Observation.identifier.period, Observation.subject.identifier.period, Observation.performer.identifier.period, Observation.hasMember.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| qty-3 | error | Observation.value[x], Observation.referenceRange.low, Observation.referenceRange.high, Observation.component.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| ref-1 | error | Observation.subject, Observation.performer, Observation.hasMember | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
| rng-2 | error | Observation.referenceRange.age | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from FIPHRSDFitness
Summary
Mandatory: 5 elements
Fixed Value: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from FIPHRSDFitness
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 0..* | FIPHRSDFitness | Finnish PHR Moderate to Vigorous Physical Activity Time profile | |
| meta | 1..1 | Meta | Metadata about the resource | |
| profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| profile:fiphrProfile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime | |
| code | ||||
| Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
| coding:moderateToVigorousWeeklyMinutes | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a week | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8 | |
| coding:moderateToVigorousPA24h | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a 24h period | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8-24h | |
| value[x] | 1..1 | Quantity | Actual result | |
| value | 1..1 | decimal | Numerical value (with implicit precision) | |
| unit | 1..1 | string | Unit representation Fixed Value: min | |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| code | 1..1 | code | Coded form of the unit Fixed Value: min | |
| component | 0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | FIPHRSDFitness | Finnish PHR Moderate to Vigorous Physical Activity Time profile |
| meta | Σ | 1..1 | Meta | Metadata about the resource |
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this |
| profile:fiphrProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
| text | N | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| creatingApplication | N | 0..* | (Complex) | Application identification URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| identifier | ΣN | 1..* | Identifier | Business Identifier for observation |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | Finnish PHR: Status final Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| category | N | 1..1 | CodeableConcept | Classification of type of observation: Binding: Value Set Finnish PHR Fitness Category (extensible): Finnish PHR: Codes for high level observation categories. |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
| coding:fiphrCategory | ΣN | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-fitnesscategory |
| code | Σ | 1..1 | code | Fitness observation category Fixed Value: fitness |
| code | ΣN | 1..1 | CodeableConcept | Type of observation (type / code) Binding: Value Set Finnish PHR Fitness Results (extensible): Codes identifying names of simple observations. |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:All Slices | Content/Rules for all slices | |||
| system | Σ | 1..1 | uri | Identity of the terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| coding:moderateToVigorousWeeklyMinutes | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a week |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8 |
| display | Σ | 1..1 | string | Representation defined by the system |
| coding:moderateToVigorousPA24h | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a 24h period |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8-24h |
| display | Σ | 1..1 | string | Representation defined by the system |
| subject | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who and/or what the observation is about |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| effective[x] | Σ | 1..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | Σ | 1..1 | instant | Finnish PHR: The date and time this observation is stored. |
| performer | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Finnish PHR: Application user who is responsible for the observation |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| value[x] | ΣC | 1..1 | Quantity | Actual result |
| value | Σ | 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 | Σ | 1..1 | string | Unit representation Fixed Value: min |
| system | ΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: min |
| interpretation | N | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:fiphrInterpretation | ΣN | 1..1 | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| hasMember | ΣCN | 0..1 | Reference(Observation | QuestionnaireResponse) {r} | Related resource that belongs to the Observation group |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.language | required | CommonLanguages |
| Observation.identifier.use | required | IdentifierUse |
| Observation.status | required | Fixed Value: final |
| Observation.category | extensible | fiphr-vs-fitnesscategory (a valid code from Code System Finnish PHR Fitness Category) |
| Observation.code | extensible | fiphr-vs-fitnessresult |
| Observation.value[x].comparator | required | QuantityComparator |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.component.code | extensible | fiphr-vs-fitnessresult |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | Observation.extension:creatingApplication, Observation.modifierExtension, Observation.component.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.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() | |
| qty-3 | error | Observation.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| ref-1 | error | Observation.subject, Observation.performer, Observation.hasMember | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | C | 0..* | FIPHRSDFitness | Finnish PHR Moderate to Vigorous Physical Activity Time profile |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | Σ | 0..1 | uri | Identifies where the resource comes from |
| Slices for profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this |
| profile:fiphrProfile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: http://phr.kanta.fi/StructureDefinition/fiphr-sd-moderatetovigorouspatime |
| security | ΣN | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag | ΣN | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 1..1 | code | Language of the resource content Binding: CommonLanguages (required): Finnish PHR: A code of human language. | |
| text | N | 1..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| creatingApplication | N | 0..* | (Complex) | Application identification URL: http://phr.kanta.fi/StructureDefinition/fiphr-ext-creatingapplication |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| identifier | ΣN | 1..* | Identifier | Business Identifier for observation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| status | ?!Σ | 1..1 | code | Finnish PHR: Status final Binding: ObservationStatus (required): Codes providing the status of an observation. Fixed Value: final |
| category | N | 1..1 | CodeableConcept | Classification of type of observation: Binding: Value Set Finnish PHR Fitness Category (extensible): Finnish PHR: Codes for high level observation categories. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
| coding:fiphrCategory | ΣN | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-fitnesscategory |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Fitness observation category Fixed Value: fitness |
| 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 | ΣN | 1..1 | CodeableConcept | Type of observation (type / code) Binding: Value Set Finnish PHR Fitness Results (extensible): Codes identifying names of simple observations. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code |
| coding:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:moderateToVigorousWeeklyMinutes | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a week |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8 |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:moderateToVigorousPA24h | Σ | 0..1 | Coding | Observation of minutes with moderate to vigorous PA during a 24h period |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://phr.kanta.fi/fiphr-cs-moderatetovigorouspa |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 82290-8-24h |
| display | Σ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Who and/or what the observation is about |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| display | Σ | 0..1 | string | Text alternative for the resource |
| effective[x] | Σ | 1..1 | Clinically relevant time/time-period for observation | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| issued | Σ | 1..1 | instant | Finnish PHR: The date and time this observation is stored. |
| performer | ΣCN | 1..1 | Reference(Finnish PHR Patient profile) {r} | Finnish PHR: Application user who is responsible for the observation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| display | Σ | 0..1 | string | Text alternative for the resource |
| value[x] | ΣC | 1..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 | Σ | 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 | Σ | 1..1 | string | Unit representation Fixed Value: min |
| system | ΣC | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
| code | Σ | 1..1 | code | Coded form of the unit Fixed Value: min |
| interpretation | N | 0..1 | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| Slices for coding | ΣN | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:fiphrInterpretation | ΣN | 1..1 | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..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 |
| note | N | 0..* | Annotation | Comments about the observation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | Σ | 1..1 | markdown | The annotation - text content (as markdown) |
| referenceRange | CN | 0..* | BackboneElement | Provides guide for interpretation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| modifierExtension | ?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| low | CN | 0..1 | SimpleQuantity | Low Range, if relevant |
| high | CN | 0..1 | SimpleQuantity | High Range, if relevant |
| type | N | 0..1 | CodeableConcept | Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range. |
| appliesTo | N | 0..* | CodeableConcept | Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to. |
| age | CN | 0..1 | Range | Applicable age range, if relevant |
| text | 0..1 | string | Text based reference range in an observation | |
| hasMember | ΣCN | 0..1 | Reference(Observation | QuestionnaireResponse) {r} | Related resource that belongs to the Observation group |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| identifier | ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | ΣN | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣCN | 0..1 | Period | Time period when id is/was valid for use |
| display | Σ | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.meta.security | extensible | All Security Labels |
| Observation.meta.tag | example | CommonTags |
| Observation.language | required | CommonLanguages |
| Observation.identifier.use | required | IdentifierUse |
| Observation.identifier.type | extensible | Identifier Type Codes |
| Observation.status | required | Fixed Value: final |
| Observation.category | extensible | fiphr-vs-fitnesscategory (a valid code from Code System Finnish PHR Fitness Category) |
| Observation.code | extensible | fiphr-vs-fitnessresult |
| Observation.subject.type | extensible | ResourceType |
| Observation.subject.identifier.use | required | IdentifierUse |
| Observation.subject.identifier.type | extensible | Identifier Type Codes |
| Observation.performer.type | extensible | ResourceType |
| Observation.performer.identifier.use | required | IdentifierUse |
| Observation.performer.identifier.type | extensible | Identifier Type Codes |
| Observation.value[x].comparator | required | QuantityComparator |
| Observation.interpretation | extensible | ObservationInterpretationCodes |
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodes |
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
| Observation.hasMember.type | extensible | ResourceType |
| Observation.hasMember.identifier.use | required | IdentifierUse |
| Observation.hasMember.identifier.type | extensible | Identifier Type Codes |
| Observation.component.code | extensible | fiphr-vs-fitnessresult |
| Observation.component.dataAbsentReason | extensible | DataAbsentReason |
| Observation.component.interpretation | extensible | ObservationInterpretationCodes |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Observation.meta.extension, Observation.extension, Observation.extension:creatingApplication, Observation.modifierExtension, Observation.identifier.extension, Observation.category.extension, Observation.category.coding:fiphrCategory.extension, Observation.code.extension, Observation.code.coding.extension, Observation.code.coding:moderateToVigorousWeeklyMinutes.extension, Observation.code.coding:moderateToVigorousPA24h.extension, Observation.subject.extension, Observation.subject.identifier.extension, Observation.performer.extension, Observation.performer.identifier.extension, Observation.value[x].extension, Observation.interpretation.extension, Observation.interpretation.coding:fiphrInterpretation.extension, Observation.note.extension, Observation.referenceRange.extension, Observation.referenceRange.modifierExtension, Observation.hasMember.extension, Observation.hasMember.identifier.extension, Observation.component.extension, Observation.component.modifierExtension, Observation.component.code.extension, Observation.component.code.coding.extension, Observation.component.interpretation.extension, Observation.component.interpretation.coding:fiphrInterpretation.extension | Must have either extensions or value[x], not both : extension.exists() != value.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() | |
| per-1 | error | Observation.identifier.period, Observation.subject.identifier.period, Observation.performer.identifier.period, Observation.hasMember.identifier.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| qty-3 | error | Observation.value[x], Observation.referenceRange.low, Observation.referenceRange.high, Observation.component.value[x] | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| ref-1 | error | Observation.subject, Observation.performer, Observation.hasMember | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
| rng-2 | error | Observation.referenceRange.age | If present, low SHALL have a lower value than high : low.empty() or high.empty() or (low <= high) | |
| sqty-1 | error | Observation.referenceRange.low, Observation.referenceRange.high | The comparator is not used on a SimpleQuantity : comparator.empty() |
This structure is derived from FIPHRSDFitness
Summary
Mandatory: 5 elements
Fixed Value: 8 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 Finland. Package hl7.fhir.fi.base#0.3.0 based on FHIR 4.0.1. Generated 2023-02-02
Links: Table of Contents
| QA Report| Version History
| 
| Source
| Propose a change