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 Referral Decline Resource

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

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

The ICP Referral Decline profile is to be used by ICP suppliers to furnish ACC with the required information following them declining an ICP referral.

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 Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
.... contained:acc-provider 1..1 ACCProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:cover-and-causation 0..1 IcpTBICoverAndCausation A structured set of questions and their answers
.... contained:start-c 0..1 IcpTBIStartC A structured set of questions and their answers
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referral-source 1..1 (Complex) (gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source
..... Slices for extension Content/Rules for all slices
...... extension:referral-source-type 1..1 Extension Extension
....... value[x] 1..1 code Value of extension
Binding: TBI Referral Source Type (required)
.... extension:referral-declined 1..1 (Complex) The declined reason and details for declining the referral
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined
..... Slices for extension Content/Rules for all slices
...... extension:reason 1..1 Extension Extension
....... value[x] 1..1 code Value of extension
Binding: Referral TBI Decline Reason (required)
.... extension:referral-assessment 0..1 (Complex) The IDT-assessment assessment of the patient must be present when an IDT-assessment has been performed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-idt-assessment
... Slices for identifier 1..1 Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Closed 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)
... statusHistory 0..0 List of past encounter statuses
... class 1..1 Coding PRENC
Binding: Encounter Class (required)
... classHistory 0..0 List of past encounter classes
... type 0..0 Specific type of encounter
... serviceType 1..1 CodeableConcept The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
..... code 1..1 code tbi
Binding: Service Type (required)
... priority 0..0 Indicates the urgency of the encounter
... subject 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... episodeOfCare 0..0 Episode(s) of care that this encounter should be recorded against
... basedOn 0..0 The ServiceRequest that initiated this encounter
... participant 1..1 BackboneElement List of participants involved in the encounter
.... type 0..* CodeableConcept PPRF
Binding: Encounter Participant (required)
.... individual 0..1 Reference(ACC Provider) Persons involved in the encounter other than the patient
... appointment 0..0 The appointment that scheduled this encounter
... period 0..0 The start and end time of the encounter
... length 0..0 Quantity of time the encounter lasted (less time absent)
... reasonCode 0..0 Coded reason the encounter takes place
... reasonReference 0..0 Reason the encounter takes place (reference)
... diagnosis 0..0 The list of diagnosis relevant to this encounter
... account 0..0 The set of accounts that may be used for billing for this Encounter
... hospitalization 0..0 Details about the admission to a healthcare service
... location 0..0 List of locations where the patient has been
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
... partOf 0..0 Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.extension:referral-source.​extension:referral-source-type.​value[x] Base required TBI Referral Source Type 📦1.1.0 This IG
Encounter.extension:referral-declined.​extension:reason.value[x] Base required Referral TBI Decline Reason 📦1.1.0 This IG
Encounter.status Base required Encounter Status 📦1.1.0 This IG
Encounter.class Base required Encounter Class 📦1.1.0 This IG
Encounter.serviceType.​coding.code Base required Service Type 📦1.1.0 This IG
Encounter.participant.​type Base required Encounter Participant 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error Encounter.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}$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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:patient 1..1 IcpPatient Patient's date of birth.
.... contained:acc-provider 1..1 ACCProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:cover-and-causation 0..1 IcpTBICoverAndCausation A structured set of questions and their answers
.... contained:start-c 0..1 IcpTBIStartC A structured set of questions and their answers
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referral-source 1..1 (Complex) (gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source
..... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
...... extension:referral-source-type 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "referral-source-type"
....... value[x] 1..1 code Value of extension
Binding: TBI Referral Source Type (required)
...... extension:received-date 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "received-date"
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source"
.... extension:referral-declined C 1..1 (Complex) The declined reason and details for declining the referral
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined
Constraints: other-reason-invariant, not-other-reason-invariant
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:date-declined 1..1 Extension Date referral declined.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "date-declined"
....... value[x] C 1..1 date Value of extension
Constraints: date-invariant, date-not-in-future-invariant
...... extension:reason 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral TBI Decline Reason (required)
...... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "other-reason"
...... extension:recommended-next-steps 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "recommended-next-steps"
....... value[x] C 1..1 string Value of extension
Constraints: recommended-next-steps-999-length-invariant
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined"
.... extension:referral-assessment 0..1 (Complex) The IDT-assessment assessment of the patient must be present when an IDT-assessment has been performed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-idt-assessment
... Slices for identifier Σ 1..1 Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Closed 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 .
..... 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 finished
Binding: Encounter Status (required)
... class Σ 1..1 Coding PRENC
Binding: Encounter Class (required)
... serviceType Σ 1..1 CodeableConcept The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
..... code Σ 1..1 code tbi
Binding: Service Type (required)
... subject Σ 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept PPRF
Binding: Encounter Participant (required)
.... individual Σ 0..1 Reference(ACC Provider) Persons involved in the encounter other than the patient
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.extension:referral-source.​extension:referral-source-type.​value[x] Base required TBI Referral Source Type 📦1.1.0 This IG
Encounter.extension:referral-declined.​extension:reason.value[x] Base required Referral TBI Decline Reason 📦1.1.0 This IG
Encounter.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required Encounter Status 📦1.1.0 This IG
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required Encounter Class 📦1.1.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v5.5
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.serviceType.​coding.code Base required Service Type 📦1.1.0 This IG
Encounter.participant.​type Base required Encounter Participant 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error Encounter.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}$')
date-invariant error Encounter.extension:referral-declined.extension:date-declined.value[x] All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
date-not-in-future-invariant error Encounter.extension:referral-declined.extension:date-declined.value[x] The date value cannot be in the future $this <= today()
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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()
not-other-reason-invariant error Encounter.extension:referral-declined if reason code is not 'other', other-reason must not be populated. (extension.where(url='reason').value != 'other' implies extension.where(url='other-reason').value.empty())
other-reason-invariant error Encounter.extension:referral-declined if reason code is 'other', other-reason is required. (extension.where(url='reason').value = 'other' implies extension.where(url='other-reason').value.exists())
recommended-next-steps-999-length-invariant error Encounter.extension:referral-declined.extension:recommended-next-steps.value[x] 'recommended-next-steps' must be less than 1000 characters. value.length() <= 999
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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:patient 1..1 IcpPatient Patient's date of birth.
.... contained:acc-provider 1..1 ACCProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:cover-and-causation 0..1 IcpTBICoverAndCausation A structured set of questions and their answers
.... contained:start-c 0..1 IcpTBIStartC A structured set of questions and their answers
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referral-source 1..1 (Complex) (gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
...... extension:referral-source-type 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "referral-source-type"
....... value[x] 1..1 code Value of extension
Binding: TBI Referral Source Type (required)
...... extension:received-date 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "received-date"
....... value[x] C 0..1 date Value of extension
Constraints: date-invariant, date-not-in-future-invariant
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source"
.... extension:referral-declined C 1..1 (Complex) The declined reason and details for declining the referral
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined
Constraints: other-reason-invariant, not-other-reason-invariant
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:date-declined 1..1 Extension Date referral declined.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "date-declined"
....... value[x] C 1..1 date Value of extension
Constraints: date-invariant, date-not-in-future-invariant
...... extension:reason 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral TBI Decline Reason (required)
...... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "other-reason"
....... value[x] C 0..1 string Value of extension
Constraints: other-reason-max110-length-invariant
...... extension:recommended-next-steps 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "recommended-next-steps"
....... value[x] C 1..1 string Value of extension
Constraints: recommended-next-steps-999-length-invariant
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined"
.... extension:referral-assessment 0..1 (Complex) The IDT-assessment assessment of the patient must be present when an IDT-assessment has been performed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-idt-assessment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..1 Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Closed 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 finished
Binding: Encounter Status (required)
... class Σ 1..1 Coding PRENC
Binding: Encounter Class (required)
... serviceType Σ 1..1 CodeableConcept The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... 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 Σ 1..1 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 Σ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code tbi
Binding: Service Type (required)
..... 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
... subject Σ 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept PPRF
Binding: Encounter Participant (required)
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(ACC Provider) Persons involved in the encounter other than the patient
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.extension:referral-source.​extension:referral-source-type.​value[x] Base required TBI Referral Source Type 📦1.1.0 This IG
Encounter.extension:referral-declined.​extension:reason.value[x] Base required Referral TBI Decline Reason 📦1.1.0 This IG
Encounter.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:icpclaimnumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.status Base required Encounter Status 📦1.1.0 This IG
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required Encounter Class 📦1.1.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v5.5
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.serviceType.​coding.code Base required Service Type 📦1.1.0 This IG
Encounter.participant.​type Base required Encounter Participant 📦1.1.0 This IG
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v5.5
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error Encounter.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}$')
date-invariant error Encounter.extension:referral-source.extension:received-date.value[x], Encounter.extension:referral-declined.extension:date-declined.value[x] All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
date-not-in-future-invariant error Encounter.extension:referral-source.extension:received-date.value[x], Encounter.extension:referral-declined.extension:date-declined.value[x] The date value cannot be in the future $this <= today()
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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()
not-other-reason-invariant error Encounter.extension:referral-declined if reason code is not 'other', other-reason must not be populated. (extension.where(url='reason').value != 'other' implies extension.where(url='other-reason').value.empty())
other-reason-invariant error Encounter.extension:referral-declined if reason code is 'other', other-reason is required. (extension.where(url='reason').value = 'other' implies extension.where(url='other-reason').value.exists())
other-reason-max110-length-invariant error Encounter.extension:referral-declined.extension:other-reason.value[x] 'other-reason' must be no more than 110 characters. value.length() <= 110
recommended-next-steps-999-length-invariant error Encounter.extension:referral-declined.extension:recommended-next-steps.value[x] 'recommended-next-steps' must be less than 1000 characters. value.length() <= 999

This structure is derived from Encounter

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... Slices for contained 2..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
.... contained:acc-provider 1..1 ACCProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:cover-and-causation 0..1 IcpTBICoverAndCausation A structured set of questions and their answers
.... contained:start-c 0..1 IcpTBIStartC A structured set of questions and their answers
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referral-source 1..1 (Complex) (gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source
..... Slices for extension Content/Rules for all slices
...... extension:referral-source-type 1..1 Extension Extension
....... value[x] 1..1 code Value of extension
Binding: TBI Referral Source Type (required)
.... extension:referral-declined 1..1 (Complex) The declined reason and details for declining the referral
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined
..... Slices for extension Content/Rules for all slices
...... extension:reason 1..1 Extension Extension
....... value[x] 1..1 code Value of extension
Binding: Referral TBI Decline Reason (required)
.... extension:referral-assessment 0..1 (Complex) The IDT-assessment assessment of the patient must be present when an IDT-assessment has been performed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-idt-assessment
... Slices for identifier 1..1 Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Closed 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)
... statusHistory 0..0 List of past encounter statuses
... class 1..1 Coding PRENC
Binding: Encounter Class (required)
... classHistory 0..0 List of past encounter classes
... type 0..0 Specific type of encounter
... serviceType 1..1 CodeableConcept The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
..... code 1..1 code tbi
Binding: Service Type (required)
... priority 0..0 Indicates the urgency of the encounter
... subject 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... episodeOfCare 0..0 Episode(s) of care that this encounter should be recorded against
... basedOn 0..0 The ServiceRequest that initiated this encounter
... participant 1..1 BackboneElement List of participants involved in the encounter
.... type 0..* CodeableConcept PPRF
Binding: Encounter Participant (required)
.... individual 0..1 Reference(ACC Provider) Persons involved in the encounter other than the patient
... appointment 0..0 The appointment that scheduled this encounter
... period 0..0 The start and end time of the encounter
... length 0..0 Quantity of time the encounter lasted (less time absent)
... reasonCode 0..0 Coded reason the encounter takes place
... reasonReference 0..0 Reason the encounter takes place (reference)
... diagnosis 0..0 The list of diagnosis relevant to this encounter
... account 0..0 The set of accounts that may be used for billing for this Encounter
... hospitalization 0..0 Details about the admission to a healthcare service
... location 0..0 List of locations where the patient has been
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
... partOf 0..0 Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.extension:referral-source.​extension:referral-source-type.​value[x] Base required TBI Referral Source Type 📦1.1.0 This IG
Encounter.extension:referral-declined.​extension:reason.value[x] Base required Referral TBI Decline Reason 📦1.1.0 This IG
Encounter.status Base required Encounter Status 📦1.1.0 This IG
Encounter.class Base required Encounter Class 📦1.1.0 This IG
Encounter.serviceType.​coding.code Base required Service Type 📦1.1.0 This IG
Encounter.participant.​type Base required Encounter Participant 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error Encounter.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}$')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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:patient 1..1 IcpPatient Patient's date of birth.
.... contained:acc-provider 1..1 ACCProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:cover-and-causation 0..1 IcpTBICoverAndCausation A structured set of questions and their answers
.... contained:start-c 0..1 IcpTBIStartC A structured set of questions and their answers
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referral-source 1..1 (Complex) (gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source
..... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
...... extension:referral-source-type 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "referral-source-type"
....... value[x] 1..1 code Value of extension
Binding: TBI Referral Source Type (required)
...... extension:received-date 0..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "received-date"
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source"
.... extension:referral-declined C 1..1 (Complex) The declined reason and details for declining the referral
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined
Constraints: other-reason-invariant, not-other-reason-invariant
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:date-declined 1..1 Extension Date referral declined.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "date-declined"
....... value[x] C 1..1 date Value of extension
Constraints: date-invariant, date-not-in-future-invariant
...... extension:reason 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral TBI Decline Reason (required)
...... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "other-reason"
...... extension:recommended-next-steps 1..1 Extension Extension
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "recommended-next-steps"
....... value[x] C 1..1 string Value of extension
Constraints: recommended-next-steps-999-length-invariant
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined"
.... extension:referral-assessment 0..1 (Complex) The IDT-assessment assessment of the patient must be present when an IDT-assessment has been performed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-idt-assessment
... Slices for identifier Σ 1..1 Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Closed 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 .
..... 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 finished
Binding: Encounter Status (required)
... class Σ 1..1 Coding PRENC
Binding: Encounter Class (required)
... serviceType Σ 1..1 CodeableConcept The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... coding Σ 1..1 Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
..... code Σ 1..1 code tbi
Binding: Service Type (required)
... subject Σ 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement List of participants involved in the encounter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept PPRF
Binding: Encounter Participant (required)
.... individual Σ 0..1 Reference(ACC Provider) Persons involved in the encounter other than the patient
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.extension:referral-source.​extension:referral-source-type.​value[x] Base required TBI Referral Source Type 📦1.1.0 This IG
Encounter.extension:referral-declined.​extension:reason.value[x] Base required Referral TBI Decline Reason 📦1.1.0 This IG
Encounter.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.status Base required Encounter Status 📦1.1.0 This IG
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required Encounter Class 📦1.1.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v5.5
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.serviceType.​coding.code Base required Service Type 📦1.1.0 This IG
Encounter.participant.​type Base required Encounter Participant 📦1.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error Encounter.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}$')
date-invariant error Encounter.extension:referral-declined.extension:date-declined.value[x] All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
date-not-in-future-invariant error Encounter.extension:referral-declined.extension:date-declined.value[x] The date value cannot be in the future $this <= today()
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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()
not-other-reason-invariant error Encounter.extension:referral-declined if reason code is not 'other', other-reason must not be populated. (extension.where(url='reason').value != 'other' implies extension.where(url='other-reason').value.empty())
other-reason-invariant error Encounter.extension:referral-declined if reason code is 'other', other-reason is required. (extension.where(url='reason').value = 'other' implies extension.where(url='other-reason').value.exists())
recommended-next-steps-999-length-invariant error Encounter.extension:referral-declined.extension:recommended-next-steps.value[x] 'recommended-next-steps' must be less than 1000 characters. value.length() <= 999

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Encounter 0..* Encounter An interaction during which services are provided to the patient
... 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:patient 1..1 IcpPatient Patient's date of birth.
.... contained:acc-provider 1..1 ACCProvider A person with a formal responsibility in the provisioning of healthcare or related services
.... contained:cover-and-causation 0..1 IcpTBICoverAndCausation A structured set of questions and their answers
.... contained:start-c 0..1 IcpTBIStartC A structured set of questions and their answers
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referral-source 1..1 (Complex) (gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..2 Extension Extension
Slice: Unordered, Open by value:url
...... extension:referral-source-type 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "referral-source-type"
....... value[x] 1..1 code Value of extension
Binding: TBI Referral Source Type (required)
...... extension:received-date 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "received-date"
....... value[x] C 0..1 date Value of extension
Constraints: date-invariant, date-not-in-future-invariant
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-source"
.... extension:referral-declined C 1..1 (Complex) The declined reason and details for declining the referral
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined
Constraints: other-reason-invariant, not-other-reason-invariant
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:date-declined 1..1 Extension Date referral declined.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "date-declined"
....... value[x] C 1..1 date Value of extension
Constraints: date-invariant, date-not-in-future-invariant
...... extension:reason 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral TBI Decline Reason (required)
...... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "other-reason"
....... value[x] C 0..1 string Value of extension
Constraints: other-reason-max110-length-invariant
...... extension:recommended-next-steps 1..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... url 1..1 uri "recommended-next-steps"
....... value[x] C 1..1 string Value of extension
Constraints: recommended-next-steps-999-length-invariant
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-referral-declined"
.... extension:referral-assessment 0..1 (Complex) The IDT-assessment assessment of the patient must be present when an IDT-assessment has been performed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-idt-assessment
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 1..1 Identifier Identifier(s) by which this encounter is known
Slice: Unordered, Closed 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 finished
Binding: Encounter Status (required)
... class Σ 1..1 Coding PRENC
Binding: Encounter Class (required)
... serviceType Σ 1..1 CodeableConcept The type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
.... 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 Σ 1..1 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 Σ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code tbi
Binding: Service Type (required)
..... 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
... subject Σ 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... participant Σ 1..1 BackboneElement List of participants involved in the encounter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 0..* CodeableConcept PPRF
Binding: Encounter Participant (required)
.... period 0..1 Period Period of time during the encounter that the participant participated
.... individual Σ 0..1 Reference(ACC Provider) Persons involved in the encounter other than the patient
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.extension:referral-source.​extension:referral-source-type.​value[x] Base required TBI Referral Source Type 📦1.1.0 This IG
Encounter.extension:referral-declined.​extension:reason.value[x] Base required Referral TBI Decline Reason 📦1.1.0 This IG
Encounter.identifier:icpclaimnumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Encounter.identifier:icpclaimnumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Encounter.status Base required Encounter Status 📦1.1.0 This IG
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base required Encounter Class 📦1.1.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v5.5
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.serviceType.​coding.code Base required Service Type 📦1.1.0 This IG
Encounter.participant.​type Base required Encounter Participant 📦1.1.0 This IG
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦2.0.0 THO v5.5
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
acc-claim-number error Encounter.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}$')
date-invariant error Encounter.extension:referral-source.extension:received-date.value[x], Encounter.extension:referral-declined.extension:date-declined.value[x] All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
date-not-in-future-invariant error Encounter.extension:referral-source.extension:received-date.value[x], Encounter.extension:referral-declined.extension:date-declined.value[x] The date value cannot be in the future $this <= today()
dom-2 error Encounter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Encounter 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 Encounter 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 Encounter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Encounter 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()
not-other-reason-invariant error Encounter.extension:referral-declined if reason code is not 'other', other-reason must not be populated. (extension.where(url='reason').value != 'other' implies extension.where(url='other-reason').value.empty())
other-reason-invariant error Encounter.extension:referral-declined if reason code is 'other', other-reason is required. (extension.where(url='reason').value = 'other' implies extension.where(url='other-reason').value.exists())
other-reason-max110-length-invariant error Encounter.extension:referral-declined.extension:other-reason.value[x] 'other-reason' must be no more than 110 characters. value.length() <= 110
recommended-next-steps-999-length-invariant error Encounter.extension:referral-declined.extension:recommended-next-steps.value[x] 'recommended-next-steps' must be less than 1000 characters. value.length() <= 999

This structure is derived from Encounter

 

Other representations of profile: CSV, Excel, Schematron