New Zealand ICP Implementation Guide
1.1.0 - draft

New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions

Resource Profile: ACC ICP Patient Referral for BIST

Official URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-bist-patient-referral Version: 1.1.0
Draft as of 2025-02-27 Computable Name: IcpBistPatientReferral

Copyright/Legal: ACC New Zealand© 2023+; Licensed Under Creative Commons No Rights Reserved.

The ACC Patient Referral resource for a BIST measurement.

A Patient Referral resource to represent a patient’s referral for an IDT assessment to be completed.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:acc-tbi-provider 1..1 ACCTbiProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:patient 1..1 IcpPatient Information about an individual or animal receiving health care services
... Slices for identifier 1..1 Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value C 1..1 string The ACC 45 number.
Constraints: acc-claim-number
..... period 0..0 Time period when id is/was valid for use
..... assigner 0..0 Organization that issued id (may be just text)
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... basedOn 0..0 What request fulfills
... replaces 0..0 What request replaces
... requisition 0..0 Composite Request ID
... category 0..0 Classification of service
... doNotPerform 0..0 True if service/procedure should not be performed
... code 0..0 What is being requested/ordered
... orderDetail 0..0 Additional order information
... quantity[x] 0..0 Service amount
... subject 1..1 Reference(ACC ICP Patient) This is the patient being referred.
... encounter 0..0 Encounter in which the request was created
... occurrence[x] 0..0 When service should occur
... asNeeded[x] 0..0 Preconditions for service
... authoredOn C 1..1 dateTime The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'.
Constraints: dateTime-not-in-future-invariant
... requester 1..1 Reference(ACC Provider) This represents the pracitioner (ACC ProviderId) and practice (ACC VendorId) referring/not referring the patient to a concussion supplier.
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) This represents the ACC-approved concussion supplier the patient is being referred to.
... locationCode 0..0 Requested location
... locationReference 0..0 Requested location
... reasonCode 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: CC TBI Referral Type (required)
... insurance 0..0 Associated insurance coverage
... supportingInfo 0..1 Reference(ACC Integrated Care Pathway TBI BIST) BIST measurement this referral is based on.
... specimen 0..0 Procedure Samples
... bodySite 0..0 Location on Body
... note 0..0 Comments
... patientInstruction 0..0 Patient or consumer-oriented instructions
... relevantHistory 0..0 Request provenance

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.reasonCode Base required CC TBI Referral Type 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error ServiceRequest.identifier:icpclaimnumber.value The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dateTime-not-in-future-invariant error ServiceRequest.authoredOn The date value cannot be in the future $this <= now()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:acc-tbi-provider 1..1 ACCTbiProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:patient 1..1 IcpPatient Information about an individual or animal receiving health care services
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:icpclaimnumber Σ 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
Constraints: acc-claim-number
Example General: 123456
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... subject Σ 1..1 Reference(ACC ICP Patient) This is the patient being referred.
... authoredOn ΣC 1..1 dateTime The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'.
Constraints: dateTime-not-in-future-invariant
... requester Σ 1..1 Reference(ACC Provider) This represents the pracitioner (ACC ProviderId) and practice (ACC VendorId) referring/not referring the patient to a concussion supplier.
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) This represents the ACC-approved concussion supplier the patient is being referred to.
... reasonCode Σ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: CC TBI Referral Type (required)
... supportingInfo 0..1 Reference(ACC Integrated Care Pathway TBI BIST) BIST measurement this referral is based on.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base required CC TBI Referral Type 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error ServiceRequest.identifier:icpclaimnumber.value The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dateTime-not-in-future-invariant error ServiceRequest.authoredOn The date value cannot be in the future $this <= now()
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()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:acc-tbi-provider 1..1 ACCTbiProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:patient 1..1 IcpPatient Information about an individual or animal receiving health care services
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..1 Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:icpclaimnumber Σ 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
Constraints: acc-claim-number
Example General: 123456
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... subject Σ 1..1 Reference(ACC ICP Patient) This is the patient being referred.
... authoredOn ΣC 1..1 dateTime The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'.
Constraints: dateTime-not-in-future-invariant
... requester Σ 1..1 Reference(ACC Provider) This represents the pracitioner (ACC ProviderId) and practice (ACC VendorId) referring/not referring the patient to a concussion supplier.
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) This represents the ACC-approved concussion supplier the patient is being referred to.
... reasonCode Σ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: CC TBI Referral Type (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... supportingInfo 0..1 Reference(ACC Integrated Care Pathway TBI BIST) BIST measurement this referral is based on.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:icpclaimnumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base required CC TBI Referral Type 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error ServiceRequest.identifier:icpclaimnumber.value The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dateTime-not-in-future-invariant error ServiceRequest.authoredOn The date value cannot be in the future $this <= now()
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: 9 elements
Fixed: 1 element
Prohibited: 25 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.contained
  • The element 1 is sliced based on the value of ServiceRequest.identifier

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:acc-tbi-provider 1..1 ACCTbiProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:patient 1..1 IcpPatient Information about an individual or animal receiving health care services
... Slices for identifier 1..1 Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:icpclaimnumber 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value C 1..1 string The ACC 45 number.
Constraints: acc-claim-number
..... period 0..0 Time period when id is/was valid for use
..... assigner 0..0 Organization that issued id (may be just text)
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... basedOn 0..0 What request fulfills
... replaces 0..0 What request replaces
... requisition 0..0 Composite Request ID
... category 0..0 Classification of service
... doNotPerform 0..0 True if service/procedure should not be performed
... code 0..0 What is being requested/ordered
... orderDetail 0..0 Additional order information
... quantity[x] 0..0 Service amount
... subject 1..1 Reference(ACC ICP Patient) This is the patient being referred.
... encounter 0..0 Encounter in which the request was created
... occurrence[x] 0..0 When service should occur
... asNeeded[x] 0..0 Preconditions for service
... authoredOn C 1..1 dateTime The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'.
Constraints: dateTime-not-in-future-invariant
... requester 1..1 Reference(ACC Provider) This represents the pracitioner (ACC ProviderId) and practice (ACC VendorId) referring/not referring the patient to a concussion supplier.
... performer 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) This represents the ACC-approved concussion supplier the patient is being referred to.
... locationCode 0..0 Requested location
... locationReference 0..0 Requested location
... reasonCode 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: CC TBI Referral Type (required)
... insurance 0..0 Associated insurance coverage
... supportingInfo 0..1 Reference(ACC Integrated Care Pathway TBI BIST) BIST measurement this referral is based on.
... specimen 0..0 Procedure Samples
... bodySite 0..0 Location on Body
... note 0..0 Comments
... patientInstruction 0..0 Patient or consumer-oriented instructions
... relevantHistory 0..0 Request provenance

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.reasonCode Base required CC TBI Referral Type 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error ServiceRequest.identifier:icpclaimnumber.value The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dateTime-not-in-future-invariant error ServiceRequest.authoredOn The date value cannot be in the future $this <= now()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:acc-tbi-provider 1..1 ACCTbiProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:patient 1..1 IcpPatient Information about an individual or animal receiving health care services
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:icpclaimnumber Σ 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
Constraints: acc-claim-number
Example General: 123456
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... subject Σ 1..1 Reference(ACC ICP Patient) This is the patient being referred.
... authoredOn ΣC 1..1 dateTime The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'.
Constraints: dateTime-not-in-future-invariant
... requester Σ 1..1 Reference(ACC Provider) This represents the pracitioner (ACC ProviderId) and practice (ACC VendorId) referring/not referring the patient to a concussion supplier.
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) This represents the ACC-approved concussion supplier the patient is being referred to.
... reasonCode Σ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: CC TBI Referral Type (required)
... supportingInfo 0..1 Reference(ACC Integrated Care Pathway TBI BIST) BIST measurement this referral is based on.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base required CC TBI Referral Type 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error ServiceRequest.identifier:icpclaimnumber.value The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dateTime-not-in-future-invariant error ServiceRequest.authoredOn The date value cannot be in the future $this <= now()
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:acc-tbi-provider 1..1 ACCTbiProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:patient 1..1 IcpPatient Information about an individual or animal receiving health care services
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..1 Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:icpclaimnumber Σ 1..1 Identifier The ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/acc-45-number
..... value ΣC 1..1 string The ACC 45 number.
Constraints: acc-claim-number
Example General: 123456
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... subject Σ 1..1 Reference(ACC ICP Patient) This is the patient being referred.
... authoredOn ΣC 1..1 dateTime The date and time that the Patient referral to an IDT assessment is created. This must be in UTC yyyy-MM-dd'T'HH:mm:ss'Z'.
Constraints: dateTime-not-in-future-invariant
... requester Σ 1..1 Reference(ACC Provider) This represents the pracitioner (ACC ProviderId) and practice (ACC VendorId) referring/not referring the patient to a concussion supplier.
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) This represents the ACC-approved concussion supplier the patient is being referred to.
... reasonCode Σ 1..1 CodeableConcept Explanation/Justification for procedure or service
Binding: CC TBI Referral Type (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... supportingInfo 0..1 Reference(ACC Integrated Care Pathway TBI BIST) BIST measurement this referral is based on.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:icpclaimnumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base required CC TBI Referral Type 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error ServiceRequest.identifier:icpclaimnumber.value The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. $this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$')
dateTime-not-in-future-invariant error ServiceRequest.authoredOn The date value cannot be in the future $this <= now()
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: 9 elements
Fixed: 1 element
Prohibited: 25 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.contained
  • The element 1 is sliced based on the value of ServiceRequest.identifier

 

Other representations of profile: CSV, Excel, Schematron