New Zealand NES IG
1.4.7-snapshot - Release
New Zealand NES IG
1.4.7-snapshot - Release
New Zealand NES IG - Local Development build (v1.4.7-snapshot) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NesEnrolment | Version: 1.4.7-snapshot | |||
| Active as of 2024-12-16 | Computable Name: NesEnrolment | |||
Adds additional, NES specific extensions for enrolments
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EpisodeOfCare |
C | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text |
  meta |
||||
  versionId |
0..0 | |||
| source |
0..0 | |||
| security |
0..0 | |||
 tag |
0..0 | |||
| language |
0..0 | |||
 Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
  contained:careManager |
0..1 | NesPractitionerRole | Contained resource for the last qualified Encounter relating to this Enrolment | |
| contained:qualifiedEncounter |
0..1 | Encounter | Contained, inline Resources | |
 contained:patient |
0..1 | NesPatient | Information about an individual or animal receiving health care services | |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expiryDate |
0..1 | date | The date on which the Enrolment will expire URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-expiry-date | |
| re-enrolmentDate |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/reenrolment-date | |
| owningOrganisation |
0..1 | Reference(HPI Organization) | Organisation that creates the enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-owner-org | |
 terminationReason |
0..1 | (Complex) | describe the reason the enrolment has ended URL: http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason | |
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: NES Enrolment Termination Reason (required) | |
| qualifiedEncounter |
0..1 | Reference(Encounter) | the last qualified Encounter relating to this Enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-encounter | |
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: NES Enrolment Status (required) | |
| statusHistory |
0..0 | |||
| type |
0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: NES Enrolment Type (required) | |
| diagnosis |
0..0 | |||
 patient |
1..1 | Reference(NES Patient) | The patient who is the focus of this episode of care | |
| referralRequest |
0..0 | |||
| team |
0..0 | |||
| account |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.extension:terminationReason.value[x] | required | Nes_enrolment_termination_reasonhttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-termination-reason | |
| EpisodeOfCare.status | required | Nes_episode_of_care_statushttps://nzhts.digital.health.nz/fhir/ValueSet/nes-episode-of-care-status | |
| EpisodeOfCare.type | required | Nes_enrolment_typehttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-type |
| Id | Grade | Path(s) | Details | Requirements |
| CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for valueCodeableConcept.text : EpisodeOfCare.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) | |
| CODEABLE-CONCEPT-TEXT-LENGTH | error | EpisodeOfCare | valueCodeableConcept.text must be less than 1024 characters : EpisodeOfCare.descendants().valueCodeableConcept.text.all(length()<1024) | |
| SYSTEM-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for system url : EpisodeOfCare.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| SYSTEM-LENGTH | error | EpisodeOfCare | System URLs must be less than 1024 characters : EpisodeOfCare.descendants().system.all(length()<1024) | |
| URL-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for URLs : EpisodeOfCare.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| URL-LENGTH | error | EpisodeOfCare | URLs must be less than 1024 characters : EpisodeOfCare.descendants().url.all(length()<1024) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:careManager |
0..1 | NesPractitionerRole | Contained resource for the last qualified Encounter relating to this Enrolment | |
| contained:qualifiedEncounter |
0..1 | Encounter | Contained, inline Resources | |
| contained:patient |
0..1 | NesPatient | Information about an individual or animal receiving health care services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expiryDate |
0..1 | date | The date on which the Enrolment will expire URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-expiry-date | |
| re-enrolmentDate |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/reenrolment-date | |
| owningOrganisation |
0..1 | Reference(HPI Organization) | Organisation that creates the enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-owner-org | |
| terminationReason |
0..1 | (Complex) | describe the reason the enrolment has ended URL: http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason | |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason" | |
 value[x] |
0..1 | CodeableConcept | Value of extension Binding: NES Enrolment Termination Reason (required) | |
| qualifiedEncounter |
0..1 | Reference(Encounter) | the last qualified Encounter relating to this Enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-encounter | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: NES Enrolment Status (required) |
| type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: NES Enrolment Type (required) |
| patient |
Σ | 1..1 | Reference(NES Patient) | The patient who is the focus of this episode of care |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.extension:terminationReason.value[x] | required | Nes_enrolment_termination_reasonhttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-termination-reason | |
| EpisodeOfCare.status | required | Nes_episode_of_care_statushttps://nzhts.digital.health.nz/fhir/ValueSet/nes-episode-of-care-status | |
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | |
| EpisodeOfCare.type | required | Nes_enrolment_typehttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-type |
| Id | Grade | Path(s) | Details | Requirements |
| CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for valueCodeableConcept.text : EpisodeOfCare.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) | |
| CODEABLE-CONCEPT-TEXT-LENGTH | error | EpisodeOfCare | valueCodeableConcept.text must be less than 1024 characters : EpisodeOfCare.descendants().valueCodeableConcept.text.all(length()<1024) | |
| SYSTEM-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for system url : EpisodeOfCare.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| SYSTEM-LENGTH | error | EpisodeOfCare | System URLs must be less than 1024 characters : EpisodeOfCare.descendants().system.all(length()<1024) | |
| URL-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for URLs : EpisodeOfCare.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| URL-LENGTH | error | EpisodeOfCare | URLs must be less than 1024 characters : EpisodeOfCare.descendants().url.all(length()<1024) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| 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 | |
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:careManager |
0..1 | NesPractitionerRole | Contained resource for the last qualified Encounter relating to this Enrolment | |
| contained:qualifiedEncounter |
0..1 | Encounter | Contained, inline Resources | |
| contained:patient |
0..1 | NesPatient | Information about an individual or animal receiving health care services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expiryDate |
0..1 | date | The date on which the Enrolment will expire URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-expiry-date | |
| re-enrolmentDate |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/reenrolment-date | |
| owningOrganisation |
0..1 | Reference(HPI Organization) | Organisation that creates the enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-owner-org | |
| terminationReason |
0..1 | (Complex) | describe the reason the enrolment has ended URL: http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: NES Enrolment Termination Reason (required) | |
| qualifiedEncounter |
0..1 | Reference(Encounter) | the last qualified Encounter relating to this Enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-encounter | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: NES Enrolment Status (required) |
| type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: NES Enrolment Type (required) |
| patient |
Σ | 1..1 | Reference(NES Patient) | The patient who is the focus of this episode of care |
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that assumes care |
| period |
Σ | 0..1 | Period | Interval during responsibility is assumed |
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.extension:terminationReason.value[x] | required | Nes_enrolment_termination_reasonhttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-termination-reason | |
| EpisodeOfCare.status | required | Nes_episode_of_care_statushttps://nzhts.digital.health.nz/fhir/ValueSet/nes-episode-of-care-status | |
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | |
| EpisodeOfCare.type | required | Nes_enrolment_typehttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-type | |
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for valueCodeableConcept.text : EpisodeOfCare.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) | |
| CODEABLE-CONCEPT-TEXT-LENGTH | error | EpisodeOfCare | valueCodeableConcept.text must be less than 1024 characters : EpisodeOfCare.descendants().valueCodeableConcept.text.all(length()<1024) | |
| SYSTEM-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for system url : EpisodeOfCare.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| SYSTEM-LENGTH | error | EpisodeOfCare | System URLs must be less than 1024 characters : EpisodeOfCare.descendants().system.all(length()<1024) | |
| URL-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for URLs : EpisodeOfCare.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| URL-LENGTH | error | EpisodeOfCare | URLs must be less than 1024 characters : EpisodeOfCare.descendants().url.all(length()<1024) |
This structure is derived from EpisodeOfCare
Summary
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text |
| meta |
||||
| versionId |
0..0 | |||
| source |
0..0 | |||
| security |
0..0 | |||
| tag |
0..0 | |||
| language |
0..0 | |||
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:careManager |
0..1 | NesPractitionerRole | Contained resource for the last qualified Encounter relating to this Enrolment | |
| contained:qualifiedEncounter |
0..1 | Encounter | Contained, inline Resources | |
| contained:patient |
0..1 | NesPatient | Information about an individual or animal receiving health care services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expiryDate |
0..1 | date | The date on which the Enrolment will expire URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-expiry-date | |
| re-enrolmentDate |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/reenrolment-date | |
| owningOrganisation |
0..1 | Reference(HPI Organization) | Organisation that creates the enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-owner-org | |
| terminationReason |
0..1 | (Complex) | describe the reason the enrolment has ended URL: http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: NES Enrolment Termination Reason (required) | |
| qualifiedEncounter |
0..1 | Reference(Encounter) | the last qualified Encounter relating to this Enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-encounter | |
| status |
1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: NES Enrolment Status (required) | |
| statusHistory |
0..0 | |||
| type |
0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: NES Enrolment Type (required) | |
| diagnosis |
0..0 | |||
| patient |
1..1 | Reference(NES Patient) | The patient who is the focus of this episode of care | |
| referralRequest |
0..0 | |||
| team |
0..0 | |||
| account |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.extension:terminationReason.value[x] | required | Nes_enrolment_termination_reasonhttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-termination-reason | |
| EpisodeOfCare.status | required | Nes_episode_of_care_statushttps://nzhts.digital.health.nz/fhir/ValueSet/nes-episode-of-care-status | |
| EpisodeOfCare.type | required | Nes_enrolment_typehttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-type |
| Id | Grade | Path(s) | Details | Requirements |
| CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for valueCodeableConcept.text : EpisodeOfCare.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) | |
| CODEABLE-CONCEPT-TEXT-LENGTH | error | EpisodeOfCare | valueCodeableConcept.text must be less than 1024 characters : EpisodeOfCare.descendants().valueCodeableConcept.text.all(length()<1024) | |
| SYSTEM-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for system url : EpisodeOfCare.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| SYSTEM-LENGTH | error | EpisodeOfCare | System URLs must be less than 1024 characters : EpisodeOfCare.descendants().system.all(length()<1024) | |
| URL-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for URLs : EpisodeOfCare.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| URL-LENGTH | error | EpisodeOfCare | URLs must be less than 1024 characters : EpisodeOfCare.descendants().url.all(length()<1024) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:careManager |
0..1 | NesPractitionerRole | Contained resource for the last qualified Encounter relating to this Enrolment | |
| contained:qualifiedEncounter |
0..1 | Encounter | Contained, inline Resources | |
| contained:patient |
0..1 | NesPatient | Information about an individual or animal receiving health care services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expiryDate |
0..1 | date | The date on which the Enrolment will expire URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-expiry-date | |
| re-enrolmentDate |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/reenrolment-date | |
| owningOrganisation |
0..1 | Reference(HPI Organization) | Organisation that creates the enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-owner-org | |
| terminationReason |
0..1 | (Complex) | describe the reason the enrolment has ended URL: http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: NES Enrolment Termination Reason (required) | |
| qualifiedEncounter |
0..1 | Reference(Encounter) | the last qualified Encounter relating to this Enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-encounter | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: NES Enrolment Status (required) |
| type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: NES Enrolment Type (required) |
| patient |
Σ | 1..1 | Reference(NES Patient) | The patient who is the focus of this episode of care |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.extension:terminationReason.value[x] | required | Nes_enrolment_termination_reasonhttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-termination-reason | |
| EpisodeOfCare.status | required | Nes_episode_of_care_statushttps://nzhts.digital.health.nz/fhir/ValueSet/nes-episode-of-care-status | |
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | |
| EpisodeOfCare.type | required | Nes_enrolment_typehttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-type |
| Id | Grade | Path(s) | Details | Requirements |
| CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for valueCodeableConcept.text : EpisodeOfCare.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) | |
| CODEABLE-CONCEPT-TEXT-LENGTH | error | EpisodeOfCare | valueCodeableConcept.text must be less than 1024 characters : EpisodeOfCare.descendants().valueCodeableConcept.text.all(length()<1024) | |
| SYSTEM-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for system url : EpisodeOfCare.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| SYSTEM-LENGTH | error | EpisodeOfCare | System URLs must be less than 1024 characters : EpisodeOfCare.descendants().system.all(length()<1024) | |
| URL-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for URLs : EpisodeOfCare.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| URL-LENGTH | error | EpisodeOfCare | URLs must be less than 1024 characters : EpisodeOfCare.descendants().url.all(length()<1024) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare |
C | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text |
| id |
Σ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed |
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| 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 | |
| Slices for contained |
0..* | Resource | Contained, inline Resources Slice: Unordered, Closed by type:$this | |
| contained:careManager |
0..1 | NesPractitionerRole | Contained resource for the last qualified Encounter relating to this Enrolment | |
| contained:qualifiedEncounter |
0..1 | Encounter | Contained, inline Resources | |
| contained:patient |
0..1 | NesPatient | Information about an individual or animal receiving health care services | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| expiryDate |
0..1 | date | The date on which the Enrolment will expire URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-expiry-date | |
| re-enrolmentDate |
0..1 | date | Extension URL: http://hl7.org.nz/fhir/StructureDefinition/reenrolment-date | |
| owningOrganisation |
0..1 | Reference(HPI Organization) | Organisation that creates the enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-owner-org | |
| terminationReason |
0..1 | (Complex) | describe the reason the enrolment has ended URL: http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org.nz/fhir/StructureDefinition/nes-enrolment-termination-reason" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: NES Enrolment Termination Reason (required) | |
| qualifiedEncounter |
0..1 | Reference(Encounter) | the last qualified Encounter relating to this Enrolment URL: http://hl7.org.nz/fhir/StructureDefinition/enrolment-encounter | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
0..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
| status |
?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: NES Enrolment Status (required) |
| type |
Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: NES Enrolment Type (required) |
| patient |
Σ | 1..1 | Reference(NES Patient) | The patient who is the focus of this episode of care |
| managingOrganization |
Σ | 0..1 | Reference(Organization) | Organization that assumes care |
| period |
Σ | 0..1 | Period | Interval during responsibility is assumed |
| careManager |
0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EpisodeOfCare.extension:terminationReason.value[x] | required | Nes_enrolment_termination_reasonhttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-termination-reason | |
| EpisodeOfCare.status | required | Nes_episode_of_care_statushttps://nzhts.digital.health.nz/fhir/ValueSet/nes-episode-of-care-status | |
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1from the FHIR Standard | |
| EpisodeOfCare.type | required | Nes_enrolment_typehttps://nzhts.digital.health.nz/fhir/ValueSet/nes-enrolment-type | |
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for valueCodeableConcept.text : EpisodeOfCare.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) | |
| CODEABLE-CONCEPT-TEXT-LENGTH | error | EpisodeOfCare | valueCodeableConcept.text must be less than 1024 characters : EpisodeOfCare.descendants().valueCodeableConcept.text.all(length()<1024) | |
| SYSTEM-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for system url : EpisodeOfCare.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| SYSTEM-LENGTH | error | EpisodeOfCare | System URLs must be less than 1024 characters : EpisodeOfCare.descendants().system.all(length()<1024) | |
| URL-ALLOWED-CHARS | error | EpisodeOfCare | character restrictions for URLs : EpisodeOfCare.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) | |
| URL-LENGTH | error | EpisodeOfCare | URLs must be less than 1024 characters : EpisodeOfCare.descendants().url.all(length()<1024) |
This structure is derived from EpisodeOfCare
Summary
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron