Te Whatu Ora Shared Care FHIR API
0.3.9 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: ManaakiNgaTahiServiceRequest

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiServiceRequest Version: 0.1.3
Active as of 2024-03-22 Computable Name: ManaakiNgaTahiServiceRequest

Service request FHIR resource for Manaaki Nga Tahi

Usage:

Formal Views of Profile Content

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

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... implicitRules 0..0
... language 0..0
... modifierExtension 0..0
... identifier 0..0
... instantiatesCanonical 0..*canonical(ActivityDefinition)Instantiates FHIR protocol or definition
... instantiatesUri 0..0
... basedOn 0..*Reference(CarePlan)What request fulfills
... replaces 0..0
... requisition 0..0
... category 0..0
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1Reference(Patient)Individual or Entity the service is ordered for
... encounter 0..0
... Slices for occurrence[x] 1..1dateTime, Period, TimingWhen service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime C0..1dateTimeWhen service should occur
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
.... occurrence[x]:occurrencePeriod C0..1PeriodWhen service should occur
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... asNeeded[x] 0..0
... performerType 0..1CodeableConceptPerformer role
Binding: ParticipantRoles (required)
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode 0..0
... locationReference 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... note 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.performerTyperequiredParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningServiceRequest.occurrence[x]:occurrenceDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-period-utc-1warningServiceRequest.occurrence[x]:occurrencePeriodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... instantiatesCanonical Σ0..*canonical(ActivityDefinition)Instantiates FHIR protocol or definition
... basedOn Σ0..*Reference(CarePlan)What request fulfills
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... subject Σ1..1Reference(Patient)Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ1..1When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
.... occurrence[x]:occurrenceDateTime ΣC0..1dateTimeWhen service should occur
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
.... occurrence[x]:occurrencePeriod ΣC0..1PeriodWhen service should occur
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (required)
... performer Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.performerTyperequiredParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningServiceRequest.occurrence[x]:occurrenceDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-period-utc-1warningServiceRequest.occurrence[x]:occurrencePeriodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension 0..*ExtensionAdditional content defined by implementations
... instantiatesCanonical Σ0..*canonical(ActivityDefinition)Instantiates FHIR protocol or definition
... basedOn Σ0..*Reference(CarePlan)What request fulfills
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

... subject Σ1..1Reference(Patient)Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ1..1When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
.... occurrence[x]:occurrenceDateTime ΣC0..1dateTimeWhen service should occur
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
.... occurrence[x]:occurrencePeriod ΣC0..1PeriodWhen service should occur
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (required)
... performer Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.performerTyperequiredParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningServiceRequest.occurrence[x]:occurrenceDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-period-utc-1warningServiceRequest.occurrence[x]:occurrencePeriodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Prohibited: 23 elements

Slices

This structure defines the following Slices:

  • The element ServiceRequest.occurrence[x] is sliced based on the value of type:$this

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... implicitRules 0..0
... language 0..0
... modifierExtension 0..0
... identifier 0..0
... instantiatesCanonical 0..*canonical(ActivityDefinition)Instantiates FHIR protocol or definition
... instantiatesUri 0..0
... basedOn 0..*Reference(CarePlan)What request fulfills
... replaces 0..0
... requisition 0..0
... category 0..0
... orderDetail 0..0
... quantity[x] 0..0
... subject 1..1Reference(Patient)Individual or Entity the service is ordered for
... encounter 0..0
... Slices for occurrence[x] 1..1dateTime, Period, TimingWhen service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime C0..1dateTimeWhen service should occur
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
.... occurrence[x]:occurrencePeriod C0..1PeriodWhen service should occur
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... asNeeded[x] 0..0
... performerType 0..1CodeableConceptPerformer role
Binding: ParticipantRoles (required)
... performer 0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode 0..0
... locationReference 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... supportingInfo 0..0
... specimen 0..0
... bodySite 0..0
... note 0..0
... patientInstruction 0..0
... relevantHistory 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.performerTyperequiredParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningServiceRequest.occurrence[x]:occurrenceDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-period-utc-1warningServiceRequest.occurrence[x]:occurrencePeriodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... instantiatesCanonical Σ0..*canonical(ActivityDefinition)Instantiates FHIR protocol or definition
... basedOn Σ0..*Reference(CarePlan)What request fulfills
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... subject Σ1..1Reference(Patient)Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ1..1When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
.... occurrence[x]:occurrenceDateTime ΣC0..1dateTimeWhen service should occur
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
.... occurrence[x]:occurrencePeriod ΣC0..1PeriodWhen service should occur
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (required)
... performer Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.performerTyperequiredParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningServiceRequest.occurrence[x]:occurrenceDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-period-utc-1warningServiceRequest.occurrence[x]:occurrencePeriodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... extension 0..*ExtensionAdditional content defined by implementations
... instantiatesCanonical Σ0..*canonical(ActivityDefinition)Instantiates FHIR protocol or definition
... basedOn Σ0..*Reference(CarePlan)What request fulfills
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here.

... subject Σ1..1Reference(Patient)Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ1..1When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
.... occurrence[x]:occurrenceDateTime ΣC0..1dateTimeWhen service should occur
fhir-hnz-dateTime-utc-1: Value of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
.... occurrence[x]:occurrencePeriod ΣC0..1PeriodWhen service should occur
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... authoredOn Σ0..1dateTimeDate request signed
... requester Σ0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer role
Binding: ParticipantRoles (required)
... performer Σ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
ServiceRequest.performerTyperequiredParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-dateTime-utc-1warningServiceRequest.occurrence[x]:occurrenceDateTimeValue of dateTime must be UTC Coordinated Universal Time (not New Zealand time)
: true
fhir-hnz-period-utc-1warningServiceRequest.occurrence[x]:occurrencePeriodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Prohibited: 23 elements

Slices

This structure defines the following Slices:

  • The element ServiceRequest.occurrence[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron