KIOLA Implementation Guide
0.1.0 - STU1
KIOLA Implementation Guide
0.1.0 - STU1
KIOLA Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.ehealth-systems.at/artifacts/StructureDefinition/kiola-measurement-request | Version: 0.1.0 | |||
| Active as of 2024-04-27 | Computable Name: KIOLAMeasurementRequest | |||
Request to perform a KIOLA vital data measurement.
To specify measurement intervals the occurrence item might be used, see here for example (TODO). The performer item contains all allowed measurement devices, see here for example (TODO). The devices specify properties like measurement units or blocked device types, see here for example (TODO).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest |
0..* | ServiceRequest | A request to measure vital data and document the results | |
  Slices for instantiatesCanonical |
1..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | |
   instantiatesCanonical:kiolaMeasurementDefinition |
1..1 | canonical(KIOLA Measurement Definition) | The measurement definition this request is based on | |
  status |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| code |
S | 1..1 | CodeableConcept | The kind of measurement that should be taken Binding: KIOLA Measurement Types (required) |
 subject |
1..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |
| reference |
0..1 | string | Reference to a patient resource linked to a KIOLA subject | |
  identifier |
S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
| Slices for occurrence[x] |
0..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this | |
 occurrence[x]:measurementInterval |
S | 0..1 | Timing | Measurement interval |
  repeat |
SC | 1..1 | Element | How many times should a measurement be taken per period kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
| frequency |
S | 1..1 | positiveInt | Measurement should be taken frequency times per period |
| period |
S | 1..1 | decimal | Measurement should be taken frequency times per period |
| periodMax |
S | 0..1 | decimal | Grace period |
| periodUnit |
S | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
 Slices for performer |
C | 1..* | Reference(Device) | Requested performer Slice: Unordered, Open by value:resolve().type kiola-measurement-supported-devices: At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. |
 performer:automaticTransmission |
S | 0..1 | Reference(KIOLA Measurement Automatic Transmission Device) {c} | Measurements might be transmitted automatically by a device like this |
| performer:manualEntry |
S | 0..1 | Reference(KIOLA Measurement Manual Entry Device) {c} | Measurements might be entered manually using a device like this |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | required | KIOLAMeasurementTypes (a valid code from KIOLA Measurement Codes)https://fhir.ehealth-systems.at/artifacts/ValueSet/KIOLAMeasurementTypesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| kiola-measurement-interval | error | ServiceRequest.occurrence[x]:measurementInterval.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) | |
| kiola-measurement-supported-devices | warning | ServiceRequest.performer | At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request to measure vital data and document the results prr-1: orderDetail SHALL only be present if code is present |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for instantiatesCanonical |
Σ | 1..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() |
| instantiatesCanonical:kiolaMeasurementDefinition |
Σ | 1..1 | canonical(KIOLA Measurement Definition) | The measurement definition this request is based on |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | The kind of measurement that should be taken Binding: KIOLA Measurement Types (required) |
| subject |
Σ | 1..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. |
| reference |
ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject |
| identifier |
S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | Measurement interval |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
| frequency |
SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period |
| period |
SΣ | 1..1 | decimal | Measurement should be taken frequency times per period |
| periodMax |
SΣ | 0..1 | decimal | Grace period |
| periodUnit |
SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
| Slices for performer |
ΣC | 1..* | Reference(Device) | Requested performer Slice: Unordered, Open by value:resolve().type kiola-measurement-supported-devices: At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. |
| performer:automaticTransmission |
SΣ | 0..1 | Reference(KIOLA Measurement Automatic Transmission Device) {c} | Measurements might be transmitted automatically by a device like this |
| performer:manualEntry |
SΣ | 0..1 | Reference(KIOLA Measurement Manual Entry Device) {c} | Measurements might be entered manually using a device like this |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0from the FHIR Standard | |
| ServiceRequest.code | required | KIOLAMeasurementTypes (a valid code from KIOLA Measurement Codes)https://fhir.ehealth-systems.at/artifacts/ValueSet/KIOLAMeasurementTypesfrom this IG | |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| kiola-measurement-interval | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) | |
| kiola-measurement-supported-devices | warning | ServiceRequest.performer | At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. : |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request to measure vital data and document the results prr-1: orderDetail SHALL only be present if code is present | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| Slices for instantiatesCanonical |
Σ | 1..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | ||||
| instantiatesCanonical:kiolaMeasurementDefinition |
Σ | 1..1 | canonical(KIOLA Measurement Definition) | The measurement definition this request is based on | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 1..1 | CodeableConcept | The kind of measurement that should be taken Binding: KIOLA Measurement Types (required) | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
 quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | Measurement interval | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
 repeat |
SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
| frequency |
SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
SΣ | 1..1 | decimal | Measurement should be taken frequency times per period | ||||
| periodMax |
SΣ | 0..1 | decimal | Grace period | ||||
| periodUnit |
SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
 code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) | ||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: Action Participant Role (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| Slices for performer |
ΣC | 1..* | Reference(Device) | Requested performer Slice: Unordered, Open by value:resolve().type kiola-measurement-supported-devices: At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. | ||||
| performer:automaticTransmission |
SΣ | 0..1 | Reference(KIOLA Measurement Automatic Transmission Device) {c} | Measurements might be transmitted automatically by a device like this | ||||
| performer:manualEntry |
SΣ | 0..1 | Reference(KIOLA Measurement Manual Entry Device) {c} | Measurements might be entered manually using a device like this | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0from the FHIR Standard | ||||
| ServiceRequest.code | required | KIOLAMeasurementTypes (a valid code from KIOLA Measurement Codes)https://fhir.ehealth-systems.at/artifacts/ValueSet/KIOLAMeasurementTypesfrom this IG | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| kiola-measurement-interval | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) | |
| kiola-measurement-supported-devices | warning | ServiceRequest.performer | At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. : |
This structure is derived from ServiceRequest
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request to measure vital data and document the results | |
| Slices for instantiatesCanonical |
1..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | |
| instantiatesCanonical:kiolaMeasurementDefinition |
1..1 | canonical(KIOLA Measurement Definition) | The measurement definition this request is based on | |
| status |
S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent |
S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| code |
S | 1..1 | CodeableConcept | The kind of measurement that should be taken Binding: KIOLA Measurement Types (required) |
| subject |
1..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | |
| reference |
0..1 | string | Reference to a patient resource linked to a KIOLA subject | |
| identifier |
S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
| Slices for occurrence[x] |
0..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this | |
| occurrence[x]:measurementInterval |
S | 0..1 | Timing | Measurement interval |
| repeat |
SC | 1..1 | Element | How many times should a measurement be taken per period kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
| frequency |
S | 1..1 | positiveInt | Measurement should be taken frequency times per period |
| period |
S | 1..1 | decimal | Measurement should be taken frequency times per period |
| periodMax |
S | 0..1 | decimal | Grace period |
| periodUnit |
S | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
| Slices for performer |
C | 1..* | Reference(Device) | Requested performer Slice: Unordered, Open by value:resolve().type kiola-measurement-supported-devices: At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. |
| performer:automaticTransmission |
S | 0..1 | Reference(KIOLA Measurement Automatic Transmission Device) {c} | Measurements might be transmitted automatically by a device like this |
| performer:manualEntry |
S | 0..1 | Reference(KIOLA Measurement Manual Entry Device) {c} | Measurements might be entered manually using a device like this |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | required | KIOLAMeasurementTypes (a valid code from KIOLA Measurement Codes)https://fhir.ehealth-systems.at/artifacts/ValueSet/KIOLAMeasurementTypesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| kiola-measurement-interval | error | ServiceRequest.occurrence[x]:measurementInterval.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) | |
| kiola-measurement-supported-devices | warning | ServiceRequest.performer | At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request to measure vital data and document the results prr-1: orderDetail SHALL only be present if code is present |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for instantiatesCanonical |
Σ | 1..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() |
| instantiatesCanonical:kiolaMeasurementDefinition |
Σ | 1..1 | canonical(KIOLA Measurement Definition) | The measurement definition this request is based on |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | The kind of measurement that should be taken Binding: KIOLA Measurement Types (required) |
| subject |
Σ | 1..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. |
| reference |
ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject |
| identifier |
S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID |
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | Measurement interval |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. |
| frequency |
SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period |
| period |
SΣ | 1..1 | decimal | Measurement should be taken frequency times per period |
| periodMax |
SΣ | 0..1 | decimal | Grace period |
| periodUnit |
SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
| Slices for performer |
ΣC | 1..* | Reference(Device) | Requested performer Slice: Unordered, Open by value:resolve().type kiola-measurement-supported-devices: At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. |
| performer:automaticTransmission |
SΣ | 0..1 | Reference(KIOLA Measurement Automatic Transmission Device) {c} | Measurements might be transmitted automatically by a device like this |
| performer:manualEntry |
SΣ | 0..1 | Reference(KIOLA Measurement Manual Entry Device) {c} | Measurements might be entered manually using a device like this |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0from the FHIR Standard | |
| ServiceRequest.code | required | KIOLAMeasurementTypes (a valid code from KIOLA Measurement Codes)https://fhir.ehealth-systems.at/artifacts/ValueSet/KIOLAMeasurementTypesfrom this IG | |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| kiola-measurement-interval | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) | |
| kiola-measurement-supported-devices | warning | ServiceRequest.performer | At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. : |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request to measure vital data and document the results prr-1: orderDetail SHALL only be present if code is present | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| Slices for instantiatesCanonical |
Σ | 1..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition Slice: Unordered, Open by profile:resolve() | ||||
| instantiatesCanonical:kiolaMeasurementDefinition |
Σ | 1..1 | canonical(KIOLA Measurement Definition) | The measurement definition this request is based on | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 1..1 | CodeableConcept | The kind of measurement that should be taken Binding: KIOLA Measurement Types (required) | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient) | Reference to a KIOLA subject, either via reference or identifier. If present, shall conform to the subject of the care plan that this treatment plan is part of. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Reference to a patient resource linked to a KIOLA subject | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
S | 0..1 | KIOLASubjectUUIDIdentifier | KIOLA Subject UUID | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | Measurement interval | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
SΣC | 1..1 | Element | How many times should a measurement be taken per period tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa kiola-measurement-interval: Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
| frequency |
SΣ | 1..1 | positiveInt | Measurement should be taken frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
SΣ | 1..1 | decimal | Measurement should be taken frequency times per period | ||||
| periodMax |
SΣ | 0..1 | decimal | Grace period | ||||
| periodUnit |
SΣ | 1..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required) | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred) | ||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: Action Participant Role (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| Slices for performer |
ΣC | 1..* | Reference(Device) | Requested performer Slice: Unordered, Open by value:resolve().type kiola-measurement-supported-devices: At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. | ||||
| performer:automaticTransmission |
SΣ | 0..1 | Reference(KIOLA Measurement Automatic Transmission Device) {c} | Measurements might be transmitted automatically by a device like this | ||||
| performer:manualEntry |
SΣ | 0..1 | Reference(KIOLA Measurement Manual Entry Device) {c} | Measurements might be entered manually using a device like this | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.3.0from the FHIR Standard | ||||
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.3.0from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.3.0from the FHIR Standard | ||||
| ServiceRequest.code | required | KIOLAMeasurementTypes (a valid code from KIOLA Measurement Codes)https://fhir.ehealth-systems.at/artifacts/ValueSet/KIOLAMeasurementTypesfrom this IG | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.3.0from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ActionParticipantRolehttp://terminology.hl7.org/ValueSet/action-participant-role | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| kiola-measurement-interval | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | Period must be at least 1d, interpreted as calendar days. Other units are not supported, except h with a value that is a multiple of 24, interpreted as 24h intervals. : periodUnit = 'd' or (periodUnit = 'h' and period mod 24 = 0) | |
| kiola-measurement-supported-devices | warning | ServiceRequest.performer | At least one supported device should be present. Otherwise a warning should be displayed when visualizing the care plan and the measurement request should be ignored when interpreting the care plan. : |
This structure is derived from ServiceRequest
Other representations of profile: CSV, Excel, Schematron