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-referral-decline Version: 1.1.0
Active as of 2022-11-20 Computable Name: IcpReferralDecline

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:

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 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 3..4 Extension Extension
Slice: Unordered, Closed by value:url
.... extension:acc-providerid 1..1 string The ACC provider Id of the practioner providing this information
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... 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
.... 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 Decline Reason (required)
.... extension:triage 0..1 (Complex) The triage assessment of the patient must be present when a triage has been performed
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
..... extension 3..4 Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:complexityScores 1..1 Icp_complexityScores Complexity Scores
...... extension:client-participation-agreement 0..1 ClientPatricitionAgreement Client Participation Agreement
....... value[x] 0..0
... 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
..... extension 0..0
..... 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
..... assigner 0..0
... statusHistory 0..0
... class 1..1 Coding PRENC
Binding: Encounter Class (required)
... classHistory 0..0
... type 0..0
... 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 msk
Binding: Service Type (required)
... priority 0..0
... subject 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 0..0
... appointment 0..0
... period 0..0
... length 0..0
... reasonCode 0..0
... reasonReference 0..0
... diagnosis 0..0
... account 0..0
... hospitalization 0..0
... location 0..0
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
... partOf 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.extension:referral-declined.extension:reason.value[x]requiredICPDeclinedReason
http://hl7.org.nz/fhir/ValueSet/acc-icp-declined-reason
From this IG
Encounter.statusrequiredICPEncounterStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status
From this IG
Encounter.classrequiredICPEncounterClassVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class
From this IG
Encounter.serviceType.coding.coderequiredICPServiceType(a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
acc-claim-numbererrorEncounter.identifier:icpclaimnumber.valueThe 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 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 3..4 Extension Extension
Slice: Unordered, Closed by value:url
.... extension:acc-providerid 1..1 string The ACC provider Id of the practioner providing this information
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... 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
.... 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
....... 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
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral Decline Reason (required)
...... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
....... extension 0..0
....... url 1..1 uri "other-reason"
...... extension:recommended-next-steps 1..1 Extension Extension
....... extension 0..0
....... 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:triage 0..1 (Complex) The triage assessment of the patient must be present when a triage has been performed
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:triage-assessment-date 1..1 date The date the triage assessment was completed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date
...... extension:acc-client-authority 1..1 boolean Indicates that the Client has agreed to ACC being able to collect, store, use, & share their information.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority
...... extension:complexityScores 1..1 (Complex) Complexity Scores
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores
...... extension:client-participation-agreement 0..1 (Complex) Client Participation Agreement
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement
....... extension 0..0
....... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement"
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage"
... 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
..... 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 msk
Binding: Service Type (required)
... subject Σ 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... 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

PathConformanceValueSetURI
Encounter.extension:referral-declined.extension:reason.value[x]requiredICPDeclinedReason
http://hl7.org.nz/fhir/ValueSet/acc-icp-declined-reason
From this IG
Encounter.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.statusrequiredICPEncounterStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status
From this IG
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredICPEncounterClassVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class
From this IG
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.serviceType.coding.coderequiredICPServiceType(a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
acc-claim-numbererrorEncounter.identifier:icpclaimnumber.valueThe 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-invarianterrorEncounter.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-invarianterrorEncounter.extension:referral-declined.extension:date-declined.value[x]The date value cannot be in the future
: $this <= today()
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
not-other-reason-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.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 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 3..4 Extension Extension
Slice: Unordered, Closed by value:url
.... extension:acc-providerid 1..1 string The ACC provider Id of the practioner providing this information
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... 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
.... 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
....... 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
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral 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
....... 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
....... 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:triage 0..1 (Complex) The triage assessment of the patient must be present when a triage has been performed
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:triage-assessment-date 1..1 date The date the triage assessment was completed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date
...... extension:acc-client-authority 1..1 boolean Indicates that the Client has agreed to ACC being able to collect, store, use, &amp; share their information.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority
...... extension:complexityScores 1..1 (Complex) Complexity Scores
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores
...... extension:client-participation-agreement 0..1 (Complex) Client Participation Agreement
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement"
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage"
... 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
..... 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 msk
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
... 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

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.extension:referral-declined.extension:reason.value[x]requiredICPDeclinedReason
http://hl7.org.nz/fhir/ValueSet/acc-icp-declined-reason
From this IG
Encounter.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:icpclaimnumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.statusrequiredICPEncounterStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status
From this IG
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredICPEncounterClassVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class
From this IG
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.serviceType.coding.coderequiredICPServiceType(a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
From this IG
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
From the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
acc-claim-numbererrorEncounter.identifier:icpclaimnumber.valueThe 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-invarianterrorEncounter.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-invarianterrorEncounter.extension:referral-declined.extension:date-declined.value[x]The date value cannot be in the future
: $this <= today()
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
not-other-reason-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.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-invarianterrorEncounter.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

Summary

Mandatory: 15 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.contained (Closed)
  • The element 1 is sliced based on the value of Encounter.identifier (Closed)

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 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 3..4 Extension Extension
Slice: Unordered, Closed by value:url
.... extension:acc-providerid 1..1 string The ACC provider Id of the practioner providing this information
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... 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
.... 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 Decline Reason (required)
.... extension:triage 0..1 (Complex) The triage assessment of the patient must be present when a triage has been performed
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
..... extension 3..4 Extension Extension
..... Slices for extension Content/Rules for all slices
...... extension:complexityScores 1..1 Icp_complexityScores Complexity Scores
...... extension:client-participation-agreement 0..1 ClientPatricitionAgreement Client Participation Agreement
....... value[x] 0..0
... 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
..... extension 0..0
..... 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
..... assigner 0..0
... statusHistory 0..0
... class 1..1 Coding PRENC
Binding: Encounter Class (required)
... classHistory 0..0
... type 0..0
... 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 msk
Binding: Service Type (required)
... priority 0..0
... subject 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... episodeOfCare 0..0
... basedOn 0..0
... participant 0..0
... appointment 0..0
... period 0..0
... length 0..0
... reasonCode 0..0
... reasonReference 0..0
... diagnosis 0..0
... account 0..0
... hospitalization 0..0
... location 0..0
... serviceProvider 1..1 Reference(Organization) This is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
... partOf 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Encounter.extension:referral-declined.extension:reason.value[x]requiredICPDeclinedReason
http://hl7.org.nz/fhir/ValueSet/acc-icp-declined-reason
From this IG
Encounter.statusrequiredICPEncounterStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status
From this IG
Encounter.classrequiredICPEncounterClassVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class
From this IG
Encounter.serviceType.coding.coderequiredICPServiceType(a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
acc-claim-numbererrorEncounter.identifier:icpclaimnumber.valueThe 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 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 3..4 Extension Extension
Slice: Unordered, Closed by value:url
.... extension:acc-providerid 1..1 string The ACC provider Id of the practioner providing this information
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... 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
.... 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
....... 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
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral Decline Reason (required)
...... extension:other-reason 0..1 Extension Descriptor for 'other' exit reason. Mandatory when the exit reason is 'other'.
....... extension 0..0
....... url 1..1 uri "other-reason"
...... extension:recommended-next-steps 1..1 Extension Extension
....... extension 0..0
....... 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:triage 0..1 (Complex) The triage assessment of the patient must be present when a triage has been performed
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:triage-assessment-date 1..1 date The date the triage assessment was completed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date
...... extension:acc-client-authority 1..1 boolean Indicates that the Client has agreed to ACC being able to collect, store, use, &amp; share their information.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority
...... extension:complexityScores 1..1 (Complex) Complexity Scores
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores
...... extension:client-participation-agreement 0..1 (Complex) Client Participation Agreement
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement
....... extension 0..0
....... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement"
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage"
... 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
..... 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 msk
Binding: Service Type (required)
... subject Σ 1..1 Reference(ACC ICP Patient) The patient or group present at the encounter
... 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

PathConformanceValueSetURI
Encounter.extension:referral-declined.extension:reason.value[x]requiredICPDeclinedReason
http://hl7.org.nz/fhir/ValueSet/acc-icp-declined-reason
From this IG
Encounter.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.statusrequiredICPEncounterStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status
From this IG
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredICPEncounterClassVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class
From this IG
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.serviceType.coding.coderequiredICPServiceType(a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
acc-claim-numbererrorEncounter.identifier:icpclaimnumber.valueThe 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-invarianterrorEncounter.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-invarianterrorEncounter.extension:referral-declined.extension:date-declined.value[x]The date value cannot be in the future
: $this <= today()
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
not-other-reason-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.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 1..* Resource Contained, inline Resources
Slice: Unordered, Closed by type:$this
.... contained:patient 1..1 IcpPatient Patient's date of birth.
... Slices for extension 3..4 Extension Extension
Slice: Unordered, Closed by value:url
.... extension:acc-providerid 1..1 string The ACC provider Id of the practioner providing this information
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-providerid
.... 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
.... 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
....... 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
....... url 1..1 uri "reason"
....... value[x] 1..1 code Value of extension
Binding: Referral 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
....... 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
....... 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:triage 0..1 (Complex) The triage assessment of the patient must be present when a triage has been performed
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 3..4 Extension Extension
Slice: Unordered, Open by value:url
...... extension:triage-assessment-date 1..1 date The date the triage assessment was completed.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage-assessment-date
...... extension:acc-client-authority 1..1 boolean Indicates that the Client has agreed to ACC being able to collect, store, use, &amp; share their information.
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-authority
...... extension:complexityScores 1..1 (Complex) Complexity Scores
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-complexity-scores
...... extension:client-participation-agreement 0..1 (Complex) Client Participation Agreement
URL: http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement"
..... url 1..1 uri "http://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage"
... 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
..... 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 msk
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
... 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

PathConformanceValueSetURI
Encounter.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Encounter.extension:referral-declined.extension:reason.value[x]requiredICPDeclinedReason
http://hl7.org.nz/fhir/ValueSet/acc-icp-declined-reason
From this IG
Encounter.identifier:icpclaimnumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Encounter.identifier:icpclaimnumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Encounter.statusrequiredICPEncounterStatusVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status
From this IG
Encounter.statusHistory.statusrequiredEncounterStatus
http://hl7.org/fhir/ValueSet/encounter-status|4.0.1
From the FHIR Standard
Encounter.classrequiredICPEncounterClassVS
http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class
From this IG
Encounter.classHistory.classextensibleActEncounterCode
http://terminology.hl7.org/ValueSet/v3-ActEncounterCode
Encounter.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Encounter.serviceType.coding.coderequiredICPServiceType(a valid code from Service Type)
http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type
From this IG
Encounter.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Encounter.diagnosis.usepreferredDiagnosisRole
http://hl7.org/fhir/ValueSet/diagnosis-role
From the FHIR Standard
Encounter.hospitalization.admitSourcepreferredAdmitSource
http://hl7.org/fhir/ValueSet/encounter-admit-source
From the FHIR Standard
Encounter.hospitalization.reAdmissionexampleHl7VSReAdmissionIndicator
http://terminology.hl7.org/ValueSet/v2-0092
Encounter.hospitalization.dietPreferenceexampleDiet
http://hl7.org/fhir/ValueSet/encounter-diet
From the FHIR Standard
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
http://hl7.org/fhir/ValueSet/encounter-special-courtesy
From the FHIR Standard
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
http://hl7.org/fhir/ValueSet/encounter-special-arrangements
From the FHIR Standard
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
http://hl7.org/fhir/ValueSet/encounter-discharge-disposition
From the FHIR Standard
Encounter.location.statusrequiredEncounterLocationStatus
http://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1
From the FHIR Standard
Encounter.location.physicalTypeexampleLocationType
http://hl7.org/fhir/ValueSet/location-physical-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
acc-claim-numbererrorEncounter.identifier:icpclaimnumber.valueThe 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-invarianterrorEncounter.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-invarianterrorEncounter.extension:referral-declined.extension:date-declined.value[x]The date value cannot be in the future
: $this <= today()
dom-2errorEncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorEncounterIf 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-4errorEncounterIf 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-5errorEncounterIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceEncounterA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
not-other-reason-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.extension:referral-declinedif 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-invarianterrorEncounter.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-invarianterrorEncounter.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

Summary

Mandatory: 15 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 22 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Encounter.contained (Closed)
  • The element 1 is sliced based on the value of Encounter.identifier (Closed)

 

Other representations of profile: CSV, Excel, Schematron