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

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ManaakiNgaTahiServiceRequest

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiServiceRequest Version: 0.1.3
Active as of 2024-11-28 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..* ServiceRequest A 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..1 Reference(Patient) Individual or Entity the service is ordered for
... encounter 0..0
... Slices for occurrence[x] 1..1 dateTime, Period, Timing When service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime 0..1 dateTime Must be in UTC timezone on the FHIR server
.... occurrence[x]:occurrencePeriod 0..1 Period Start | end value must be in UTC timezone on the FHIR server
... asNeeded[x] 0..0
... performerType 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (required)
... performer 0..1 Reference(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
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A 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..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ 1..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
.... occurrence[x]:occurrencePeriod Σ 0..1 Period Start | end value must be in UTC timezone on the FHIR server
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (required)
... performer Σ 0..1 Reference(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
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... extension 0..* Extension Additional content defined by implementations
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition) Instantiates FHIR protocol or definition
... basedOn Σ 0..* Reference(CarePlan) What request fulfills
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

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

... 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 Σ 0..1 CodeableConcept ​What 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 and a valueset using LOINC Order codes is available here.

... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ 1..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
.... occurrence[x]:occurrencePeriod Σ 0..1 Period Start | end value must be in UTC timezone on the FHIR server
... 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: ParticipantRoles (required)
... performer Σ 0..1 Reference(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

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Prohibited: 23 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* ServiceRequest A 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..1 Reference(Patient) Individual or Entity the service is ordered for
... encounter 0..0
... Slices for occurrence[x] 1..1 dateTime, Period, Timing When service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime 0..1 dateTime Must be in UTC timezone on the FHIR server
.... occurrence[x]:occurrencePeriod 0..1 Period Start | end value must be in UTC timezone on the FHIR server
... asNeeded[x] 0..0
... performerType 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (required)
... performer 0..1 Reference(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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A 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..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ 1..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
.... occurrence[x]:occurrencePeriod Σ 0..1 Period Start | end value must be in UTC timezone on the FHIR server
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (required)
... performer Σ 0..1 Reference(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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... extension 0..* Extension Additional content defined by implementations
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition) Instantiates FHIR protocol or definition
... basedOn Σ 0..* Reference(CarePlan) What request fulfills
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

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

... 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 Σ 0..1 CodeableConcept ​What 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 and a valueset using LOINC Order codes is available here.

... subject Σ 1..1 Reference(Patient) Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ 1..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
.... occurrence[x]:occurrencePeriod Σ 0..1 Period Start | end value must be in UTC timezone on the FHIR server
... 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: ParticipantRoles (required)
... performer Σ 0..1 Reference(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

This structure is derived from ServiceRequest

Summary

Mandatory: 1 element
Prohibited: 23 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron