Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build
Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/crih/StructureDefinition/NZCentralRegionReferral | Version: 1.0.12-rc1 | |||
| Active as of 2024-09-17 | Computable Name: NZCentralRegionReferral | |||
Referral flavour of ServiceRequest resource for Te Whatu Ora, Central Region
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 for a service to be performed | |
  meta |
||||
   extension |
1..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
  url |
1..1 | uri | identifies the meaning of the extension | |
 value[x] |
0..1 | base64Binary | Value of extension | |
 process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
 l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| contained |
0..0 | |||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 referral |
S | 1..1 | (Complex) | NZ Central Region Referral URL: https://standards.digital.health.nz/ns/central-region/referral |
 Slices for extension |
Content/Rules for all slices | |||
| extension:consultingPractitioner |
0..* | Extension | Extension | |
| value[x] |
||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") | |
| identifier |
||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
||||
| coding |
||||
| 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 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
0..1 | string | The value that is unique | |
| display |
0..0 | string | ||
| extension:preferredSite |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:referralSource |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:referringPractice |
0..1 | Extension | Extension | |
| value[x] |
||||
| type |
1..1 | uri | Medical Practice is an Organisation | |
| identifier |
||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
||||
| coding |
||||
| 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 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
0..1 | string | The value that is unique | |
| display |
0..0 | string | ||
| extension:healthPurchaser |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:clinicType |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:lastUpdated |
0..1 | Extension | Extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:informGP |
0..1 | Extension | Extension | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:webPASPriority |
0..1 | Extension | Extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| 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 | |
| extension:webPASStatus |
0..1 | Extension | Extension | |
| value[x] |
||||
| 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 | |
| extension:dateReceived |
0..1 | Extension | Extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:effectiveDateTime |
0..1 | Extension | Extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| identifier |
S | 1..* | Identifier | Identifiers assigned to this order |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: FILL |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Filler Identifier |
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| instantiatesCanonical |
0..0 | |||
| instantiatesUri |
0..0 | |||
| basedOn |
0..0 | |||
| replaces |
0..0 | |||
| requisition |
0..0 | |||
| 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 |
| category |
S | 0..0 | ||
| priority |
S | 1..1 | code | routine | urgent | asap | stat |
| doNotPerform |
0..0 | |||
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered Binding: NZ Central Region - Referral Type Value Set (required) |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| system |
S | 1..1 | uri | Identity of the terminology system |
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| orderDetail |
S | 0..0 | ||
| quantity[x] |
S | 0..0 | ||
| subject |
S | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
S | 0..1 | string | Text alternative for the resource |
| encounter |
0..0 | |||
| occurrence[x] |
0..0 | |||
| asNeeded[x] |
0..0 | |||
| authoredOn |
S | 0..1 | dateTime | Date request signed |
| requester |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
| identifier |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
0..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| performerType |
0..0 | |||
| performer |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
0..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| locationCode |
S | 0..1 | CodeableConcept | Requested location Binding: NZ Central Region - Department Value Set (required) |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| locationReference |
S | 0..0 | ||
| reasonCode |
S | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: NZ Central Region - Referral Reason Value Set (required) |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| reasonReference |
0..0 | |||
| insurance |
0..0 | |||
| supportingInfo |
0..1 | Reference(Resource) | Additional clinical information | |
| specimen |
0..0 | |||
| bodySite |
0..0 | |||
| note |
0..1 | Annotation | Comments | |
| patientInstruction |
0..0 | |||
| relevantHistory |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | required | NZCentralRegionReferralTypeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-typefrom this IG | |
| ServiceRequest.locationCode | required | NZCentralRegionDepartmentValueSet (a valid code from NZ Central Region - Department Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-department-codefrom this IG | |
| ServiceRequest.reasonCode | required | NZCentralRegionReferralReasonValueSet (a valid code from NZ Central Region - Referral Reason Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-reasonfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
 meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| extension |
0..0 | |||
 url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| referral |
S | 1..1 | (Complex) | NZ Central Region Referral URL: https://standards.digital.health.nz/ns/central-region/referral |
 Slices for extension |
2..* | Extension | Container holding the individual elements of the Referral extension. Slice: Unordered, Open by value:url | |
 extension:consultingPractitioner |
S | 0..* | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "consultingPractitioner" | |
 value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| 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 |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:preferredSite |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "preferredSite" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Site Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referralSource |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "referralSource" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Source Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referringPractice |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "referringPractice" | |
| value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Medical Practice is an Organisation Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:healthPurchaser |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthPurchaser" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Health Purchaser Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Clinic Type Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicId |
S | 0..1 | Extension | Which particular clinic is the referral for? |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicId" | |
| extension:healthSpeciality |
S | 1..1 | Extension | What category of treatment is the patient to receive? |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthSpeciality" | |
| extension:financialClass |
S | 1..1 | Extension | The source of payment/reimbursement for treatment. |
| extension |
0..0 | |||
| url |
1..1 | uri | "financialClass" | |
| extension:lastUpdated |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdated" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:informGP |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "informGP" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:webPASPriority |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASPriority" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Priority Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:webPASStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASStatus" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Status Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:dateReceived |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "dateReceived" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:effectiveDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "effectiveDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/referral" | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: FILL |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Filler Identifier |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| 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. |
| priority |
SΣ | 1..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: NZ Central Region - Referral Type Value Set (required) |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| subject |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..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). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed |
| requester |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| locationCode |
SΣ | 0..1 | CodeableConcept | Requested location Binding: NZ Central Region - Department Value Set (required) |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: NZ Central Region - Referral Reason Value Set (required) |
| supportingInfo |
0..1 | Reference(Resource) | Additional clinical information | |
| note |
0..1 | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:preferredSite.value[x] | required | NZCentralRegionReferralSiteValueSet (a valid code from NZ Central Region - Referral Site Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sitefrom this IG | |
| ServiceRequest.extension:referral.extension:referralSource.value[x] | required | NZCentralRegionReferralSourceValueSet (a valid code from NZ Central Region - Referral Source Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sourcefrom this IG | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].type | extensible | Pattern: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:healthPurchaser.value[x] | required | NZCentralRegionHealthPurchaserValueSet (a valid code from NZ Central Region - Health Purchaser Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-health-purchaserfrom this IG | |
| ServiceRequest.extension:referral.extension:clinicType.value[x] | required | NZCentralRegionClinicTypeValueSet (a valid code from NZ Central Region - Clinic Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-clinic-codefrom this IG | |
| ServiceRequest.extension:referral.extension:webPASPriority.value[x] | required | NZCentralRegionReferralPriorityValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-priorityfrom this IG | |
| ServiceRequest.extension:referral.extension:webPASStatus.value[x] | required | NZCentralRegionReferralStatusValueSet (a valid code from NZ Central Region - Referral Status Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-statusfrom this IG | |
| ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | required | NZCentralRegionReferralTypeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-typefrom this IG | |
| ServiceRequest.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.requester.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.requester.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.requester.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.performer.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.performer.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.performer.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.locationCode | required | NZCentralRegionDepartmentValueSet (a valid code from NZ Central Region - Department Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-department-codefrom this IG | |
| ServiceRequest.reasonCode | required | NZCentralRegionReferralReasonValueSet (a valid code from NZ Central Region - Referral Reason Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-reasonfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| 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 |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag |
Σ | 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". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| referral |
S | 1..1 | (Complex) | NZ Central Region Referral URL: https://standards.digital.health.nz/ns/central-region/referral |
| Slices for extension |
2..* | Extension | Container holding the individual elements of the Referral extension. Slice: Unordered, Open by value:url | |
| extension:consultingPractitioner |
S | 0..* | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "consultingPractitioner" | |
| value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| 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 |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:preferredSite |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "preferredSite" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Site Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referralSource |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "referralSource" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Source Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referringPractice |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "referringPractice" | |
| value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Medical Practice is an Organisation Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:healthPurchaser |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthPurchaser" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Health Purchaser Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Clinic Type Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicId |
S | 0..1 | Extension | Which particular clinic is the referral for? |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicId" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:healthSpeciality |
S | 1..1 | Extension | What category of treatment is the patient to receive? |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthSpeciality" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:financialClass |
S | 1..1 | Extension | The source of payment/reimbursement for treatment. |
| extension |
0..0 | |||
| url |
1..1 | uri | "financialClass" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:lastUpdated |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdated" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:informGP |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "informGP" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:webPASPriority |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASPriority" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Priority Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:webPASStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASStatus" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Status Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:dateReceived |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "dateReceived" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:effectiveDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "effectiveDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/referral" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: FILL |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Filler Identifier |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| 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. |
| priority |
SΣ | 1..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: NZ Central Region - Referral Type Value Set (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 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 |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..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). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed |
| requester |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| locationCode |
SΣ | 0..1 | CodeableConcept | Requested location Binding: NZ Central Region - Department Value Set (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: NZ Central Region - Referral Reason Value Set (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| 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 |
| supportingInfo |
0..1 | Reference(Resource) | Additional clinical information | |
| note |
0..1 | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| ServiceRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:preferredSite.value[x] | required | NZCentralRegionReferralSiteValueSet (a valid code from NZ Central Region - Referral Site Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sitefrom this IG | |
| ServiceRequest.extension:referral.extension:referralSource.value[x] | required | NZCentralRegionReferralSourceValueSet (a valid code from NZ Central Region - Referral Source Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sourcefrom this IG | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].type | extensible | Pattern: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:healthPurchaser.value[x] | required | NZCentralRegionHealthPurchaserValueSet (a valid code from NZ Central Region - Health Purchaser Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-health-purchaserfrom this IG | |
| ServiceRequest.extension:referral.extension:clinicType.value[x] | required | NZCentralRegionClinicTypeValueSet (a valid code from NZ Central Region - Clinic Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-clinic-codefrom this IG | |
| ServiceRequest.extension:referral.extension:webPASPriority.value[x] | required | NZCentralRegionReferralPriorityValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-priorityfrom this IG | |
| ServiceRequest.extension:referral.extension:webPASStatus.value[x] | required | NZCentralRegionReferralStatusValueSet (a valid code from NZ Central Region - Referral Status Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-statusfrom this IG | |
| ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | required | NZCentralRegionReferralTypeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-typefrom this IG | |
| ServiceRequest.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.requester.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.requester.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.requester.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.performer.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.performer.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.performer.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.locationCode | required | NZCentralRegionDepartmentValueSet (a valid code from NZ Central Region - Department Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-department-codefrom this IG | |
| ServiceRequest.reasonCode | required | NZCentralRegionReferralReasonValueSet (a valid code from NZ Central Region - Referral Reason Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-reasonfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from ServiceRequest
Summary
Mandatory: 15 elements(29 nested mandatory elements)
Must-Support: 72 elements
Prohibited: 73 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
| meta |
||||
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| url |
1..1 | uri | identifies the meaning of the extension | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| contained |
0..0 | |||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| referral |
S | 1..1 | (Complex) | NZ Central Region Referral URL: https://standards.digital.health.nz/ns/central-region/referral |
| Slices for extension |
Content/Rules for all slices | |||
| extension:consultingPractitioner |
0..* | Extension | Extension | |
| value[x] |
||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") | |
| identifier |
||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
||||
| coding |
||||
| 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 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
0..1 | string | The value that is unique | |
| display |
0..0 | string | ||
| extension:preferredSite |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:referralSource |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:referringPractice |
0..1 | Extension | Extension | |
| value[x] |
||||
| type |
1..1 | uri | Medical Practice is an Organisation | |
| identifier |
||||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) | |
| type |
||||
| coding |
||||
| 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 | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
0..1 | string | The value that is unique | |
| display |
0..0 | string | ||
| extension:healthPurchaser |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:clinicType |
0..1 | Extension | Extension | |
| value[x] |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| extension:lastUpdated |
0..1 | Extension | Extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:informGP |
0..1 | Extension | Extension | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:webPASPriority |
0..1 | Extension | Extension | |
| value[x] |
1..1 | Coding | Value of extension | |
| 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 | |
| extension:webPASStatus |
0..1 | Extension | Extension | |
| value[x] |
||||
| 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 | |
| extension:dateReceived |
0..1 | Extension | Extension | |
| value[x] |
0..1 | date | Value of extension | |
| extension:effectiveDateTime |
0..1 | Extension | Extension | |
| value[x] |
0..1 | dateTime | Value of extension | |
| identifier |
S | 1..* | Identifier | Identifiers assigned to this order |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: FILL |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Filler Identifier |
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| instantiatesCanonical |
0..0 | |||
| instantiatesUri |
0..0 | |||
| basedOn |
0..0 | |||
| replaces |
0..0 | |||
| requisition |
0..0 | |||
| 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 |
| category |
S | 0..0 | ||
| priority |
S | 1..1 | code | routine | urgent | asap | stat |
| doNotPerform |
0..0 | |||
| code |
S | 1..1 | CodeableConcept | What is being requested/ordered Binding: NZ Central Region - Referral Type Value Set (required) |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| system |
S | 1..1 | uri | Identity of the terminology system |
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| orderDetail |
S | 0..0 | ||
| quantity[x] |
S | 0..0 | ||
| subject |
S | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. "Patient") Required Pattern: Patient |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
S | 1..1 | string | The value that is unique |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
S | 0..1 | string | Text alternative for the resource |
| encounter |
0..0 | |||
| occurrence[x] |
0..0 | |||
| asNeeded[x] |
0..0 | |||
| authoredOn |
S | 0..1 | dateTime | Date request signed |
| requester |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
| identifier |
S | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
0..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| performerType |
0..0 | |||
| performer |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
| id |
0..0 | |||
| extension |
0..0 | |||
| reference |
S | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
S | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Required Pattern: Practitioner |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
S | 1..1 | code | usual | official | temp | secondary | old (If known) |
| type |
S | 1..1 | CodeableConcept | Description of identifier |
| id |
0..0 | |||
| extension |
0..0 | |||
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
S | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
0..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| display |
0..0 | |||
| locationCode |
S | 0..1 | CodeableConcept | Requested location Binding: NZ Central Region - Department Value Set (required) |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| id |
0..0 | |||
| extension |
0..0 | |||
| system |
S | 1..1 | uri | Identity of the terminology system |
| version |
0..0 | |||
| code |
S | 1..1 | code | Symbol in syntax defined by the system |
| display |
S | 1..1 | string | Representation defined by the system |
| userSelected |
0..0 | |||
| text |
0..0 | |||
| locationReference |
S | 0..0 | ||
| reasonCode |
S | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: NZ Central Region - Referral Reason Value Set (required) |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| reasonReference |
0..0 | |||
| insurance |
0..0 | |||
| supportingInfo |
0..1 | Reference(Resource) | Additional clinical information | |
| specimen |
0..0 | |||
| bodySite |
0..0 | |||
| note |
0..1 | Annotation | Comments | |
| patientInstruction |
0..0 | |||
| relevantHistory |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | required | NZCentralRegionReferralTypeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-typefrom this IG | |
| ServiceRequest.locationCode | required | NZCentralRegionDepartmentValueSet (a valid code from NZ Central Region - Department Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-department-codefrom this IG | |
| ServiceRequest.reasonCode | required | NZCentralRegionReferralReasonValueSet (a valid code from NZ Central Region - Referral Reason Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-reasonfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| referral |
S | 1..1 | (Complex) | NZ Central Region Referral URL: https://standards.digital.health.nz/ns/central-region/referral |
| Slices for extension |
2..* | Extension | Container holding the individual elements of the Referral extension. Slice: Unordered, Open by value:url | |
| extension:consultingPractitioner |
S | 0..* | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "consultingPractitioner" | |
| value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| 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 |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:preferredSite |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "preferredSite" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Site Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referralSource |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "referralSource" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Source Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referringPractice |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "referringPractice" | |
| value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Medical Practice is an Organisation Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:healthPurchaser |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthPurchaser" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Health Purchaser Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Clinic Type Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicId |
S | 0..1 | Extension | Which particular clinic is the referral for? |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicId" | |
| extension:healthSpeciality |
S | 1..1 | Extension | What category of treatment is the patient to receive? |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthSpeciality" | |
| extension:financialClass |
S | 1..1 | Extension | The source of payment/reimbursement for treatment. |
| extension |
0..0 | |||
| url |
1..1 | uri | "financialClass" | |
| extension:lastUpdated |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdated" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:informGP |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "informGP" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:webPASPriority |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASPriority" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Priority Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:webPASStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASStatus" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Status Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:dateReceived |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "dateReceived" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:effectiveDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "effectiveDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/referral" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: FILL |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Filler Identifier |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| 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. |
| priority |
SΣ | 1..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: NZ Central Region - Referral Type Value Set (required) |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| subject |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..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). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed |
| requester |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| locationCode |
SΣ | 0..1 | CodeableConcept | Requested location Binding: NZ Central Region - Department Value Set (required) |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: NZ Central Region - Referral Reason Value Set (required) |
| supportingInfo |
0..1 | Reference(Resource) | Additional clinical information | |
| note |
0..1 | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:preferredSite.value[x] | required | NZCentralRegionReferralSiteValueSet (a valid code from NZ Central Region - Referral Site Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sitefrom this IG | |
| ServiceRequest.extension:referral.extension:referralSource.value[x] | required | NZCentralRegionReferralSourceValueSet (a valid code from NZ Central Region - Referral Source Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sourcefrom this IG | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].type | extensible | Pattern: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:healthPurchaser.value[x] | required | NZCentralRegionHealthPurchaserValueSet (a valid code from NZ Central Region - Health Purchaser Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-health-purchaserfrom this IG | |
| ServiceRequest.extension:referral.extension:clinicType.value[x] | required | NZCentralRegionClinicTypeValueSet (a valid code from NZ Central Region - Clinic Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-clinic-codefrom this IG | |
| ServiceRequest.extension:referral.extension:webPASPriority.value[x] | required | NZCentralRegionReferralPriorityValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-priorityfrom this IG | |
| ServiceRequest.extension:referral.extension:webPASStatus.value[x] | required | NZCentralRegionReferralStatusValueSet (a valid code from NZ Central Region - Referral Status Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-statusfrom this IG | |
| ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | required | NZCentralRegionReferralTypeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-typefrom this IG | |
| ServiceRequest.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.requester.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.requester.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.requester.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.performer.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.performer.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.performer.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.locationCode | required | NZCentralRegionDepartmentValueSet (a valid code from NZ Central Region - Department Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-department-codefrom this IG | |
| ServiceRequest.reasonCode | required | NZCentralRegionReferralReasonValueSet (a valid code from NZ Central Region - Referral Reason Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-reasonfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hl7v2Message |
S | 1..1 | (Complex) | HL7 v2 Message URL: https://standards.digital.health.nz/ns/central-region/hl7v2-message |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/hl7v2-message" | |
| value[x] |
0..1 | base64Binary | Value of extension | |
| process-timestamp |
S | 0..1 | dateTime | Process TimeStamp URL: http://ibm.com/fhir/cdm/StructureDefinition/process-timestamp |
| source-event-trigger |
S | 0..1 | CodeableConcept | Source Event Trigger URL: http://ibm.com/fhir/cdm/StructureDefinition/source-event-trigger Binding: hl7VS-eventTypeCode (required) |
| source-record-type |
S | 0..1 | CodeableConcept | Source Record Type URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-type Binding: hl7VS-messageType (required) |
| source-record-id |
S | 0..1 | string | Source Record ID URL: http://ibm.com/fhir/cdm/StructureDefinition/source-record-id |
| source-data-mode-version |
S | 0..1 | string | Source Data Model Version URL: http://ibm.com/fhir/cdm/StructureDefinition/source-data-model-version |
| process-client-id |
S | 0..1 | string | Process Client ID URL: http://ibm.com/fhir/cdm/StructureDefinition/process-client-id |
| l4h-template-version |
S | 0..1 | string | L4H Template Version URL: https://standards.digital.health.nz/ns/central-region/l4h-template-version |
| 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 |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
| tag |
Σ | 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". |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| referral |
S | 1..1 | (Complex) | NZ Central Region Referral URL: https://standards.digital.health.nz/ns/central-region/referral |
| Slices for extension |
2..* | Extension | Container holding the individual elements of the Referral extension. Slice: Unordered, Open by value:url | |
| extension:consultingPractitioner |
S | 0..* | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "consultingPractitioner" | |
| value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| 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 |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:preferredSite |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "preferredSite" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Site Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referralSource |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "referralSource" | |
| value[x] |
S | 1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Source Value Set (required) |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:referringPractice |
S | 0..1 | Extension | Extension |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "referringPractice" | |
| value[x] |
0..1 | Reference() | Value of extension | |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Medical Practice is an Organisation Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practice-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| extension:healthPurchaser |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthPurchaser" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Health Purchaser Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicType |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicType" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Clinic Type Value Set (required) | |
| extension |
0..0 | |||
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| display |
Σ | 0..1 | string | Representation defined by the system |
| extension:clinicId |
S | 0..1 | Extension | Which particular clinic is the referral for? |
| extension |
0..0 | |||
| url |
1..1 | uri | "clinicId" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:healthSpeciality |
S | 1..1 | Extension | What category of treatment is the patient to receive? |
| extension |
0..0 | |||
| url |
1..1 | uri | "healthSpeciality" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:financialClass |
S | 1..1 | Extension | The source of payment/reimbursement for treatment. |
| extension |
0..0 | |||
| url |
1..1 | uri | "financialClass" | |
| value[x] |
0..1 | string | Value of extension | |
| extension:lastUpdated |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "lastUpdated" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| extension:informGP |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "informGP" | |
| value[x] |
0..1 | boolean | Value of extension | |
| extension:webPASPriority |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASPriority" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Priority Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:webPASStatus |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "webPASStatus" | |
| value[x] |
1..1 | Coding | Value of extension Binding: NZ Central Region - Referral Status Value Set (required) | |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| extension:dateReceived |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "dateReceived" | |
| value[x] |
0..1 | date | Value of extension | |
| extension:effectiveDateTime |
S | 0..1 | Extension | Extension |
| extension |
0..0 | |||
| url |
1..1 | uri | "effectiveDateTime" | |
| value[x] |
0..1 | dateTime | Value of extension | |
| url |
1..1 | uri | "https://standards.digital.health.nz/ns/central-region/referral" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: FILL |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Filler Identifier |
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text |
Σ | 0..1 | string | Plain text representation of the concept |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| 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. |
| priority |
SΣ | 1..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: NZ Central Region - Referral Type Value Set (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 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 |
SΣ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..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). Required Pattern: Patient |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| display |
SΣ | 0..1 | string | Text alternative for the resource |
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed |
| requester |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer |
| extension |
0..0 | |||
| reference |
SΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type |
SΣ | 1..1 | uri | Type the reference refers to (e.g. 'Practitioner') Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Practitioner |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| extension |
0..0 | |||
| use |
?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type |
SΣ | 1..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. |
| extension |
0..0 | |||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: LR |
| display |
SΣ | 1..1 | string | Representation defined by the system Required Pattern: Local Registry ID |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://standards.digital.health.nz/ns/central-region/pas-practitioner-id |
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 |
| locationCode |
SΣ | 0..1 | CodeableConcept | Requested location Binding: NZ Central Region - Department Value Set (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| extension |
0..0 | |||
| system |
SΣ | 1..1 | uri | Identity of the terminology system |
| code |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: NZ Central Region - Referral Reason Value Set (required) |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding |
Σ | 0..* | Coding | Code defined by a terminology system |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| system |
Σ | 0..1 | uri | Identity of the terminology system |
| version |
Σ | 0..1 | string | Version of the system - if relevant |
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system |
| 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 |
| supportingInfo |
0..1 | Reference(Resource) | Additional clinical information | |
| note |
0..1 | Annotation | Comments | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| ServiceRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:consultingPractitioner.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:preferredSite.value[x] | required | NZCentralRegionReferralSiteValueSet (a valid code from NZ Central Region - Referral Site Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sitefrom this IG | |
| ServiceRequest.extension:referral.extension:referralSource.value[x] | required | NZCentralRegionReferralSourceValueSet (a valid code from NZ Central Region - Referral Source Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-sourcefrom this IG | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].type | extensible | Pattern: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.extension:referral.extension:referringPractice.value[x].identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.extension:referral.extension:healthPurchaser.value[x] | required | NZCentralRegionHealthPurchaserValueSet (a valid code from NZ Central Region - Health Purchaser Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-health-purchaserfrom this IG | |
| ServiceRequest.extension:referral.extension:clinicType.value[x] | required | NZCentralRegionClinicTypeValueSet (a valid code from NZ Central Region - Clinic Type Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-clinic-codefrom this IG | |
| ServiceRequest.extension:referral.extension:webPASPriority.value[x] | required | NZCentralRegionReferralPriorityValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-priorityfrom this IG | |
| ServiceRequest.extension:referral.extension:webPASStatus.value[x] | required | NZCentralRegionReferralStatusValueSet (a valid code from NZ Central Region - Referral Status Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-statusfrom this IG | |
| ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | required | NZCentralRegionReferralTypeValueSethttps://standards.digital.health.nz/fhir/central-region/ValueSet-referral-typefrom this IG | |
| ServiceRequest.subject.type | extensible | Pattern: Patienthttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.requester.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.requester.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.requester.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.performer.type | extensible | Pattern: Practitionerhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| ServiceRequest.performer.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.performer.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.locationCode | required | NZCentralRegionDepartmentValueSet (a valid code from NZ Central Region - Department Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-department-codefrom this IG | |
| ServiceRequest.reasonCode | required | NZCentralRegionReferralReasonValueSet (a valid code from NZ Central Region - Referral Reason Code System)https://standards.digital.health.nz/fhir/central-region/ValueSet-referral-reasonfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from ServiceRequest
Summary
Mandatory: 15 elements(29 nested mandatory elements)
Must-Support: 72 elements
Prohibited: 73 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron