New Zealand NES IG
1.4.7 - Release
New Zealand NES IG
1.4.7 - Release
New Zealand NES IG - Local Development build (v1.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/NesEncounter | Version: 1.4.7 | |||
| Active as of 2025-01-28 | Computable Name: NesEncounter | |||
Restricts Encounter to the elemrnts need to describe an NES Enrolment qualified Encounter
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter |
0..* | Encounter | An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children |
  class |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode |
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |
 language |
0..0 | |||
| statusHistory |
0..0 | |||
| classHistory |
0..0 | |||
| type |
0..0 | |||
| serviceType |
0..0 | |||
| priority |
0..0 | |||
| subject |
0..0 | |||
| episodeOfCare |
0..0 | |||
| basedOn |
0..0 | |||
| participant |
0..0 | |||
| appointment |
0..0 | |||
| length |
0..0 | |||
| reasonCode |
0..0 | |||
| reasonReference |
0..0 | |||
| diagnosis |
0..0 | |||
| account |
0..0 | |||
| hospitalization |
0..0 | |||
| location |
0..0 | |||
| serviceProvider |
0..0 | |||
| partOf |
0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| contained |
0..* | Resource | Contained, inline Resources | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known |
| status |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
| class |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
| period |
0..1 | Period | The start and end time of the encounter | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard | |
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourcefrom the FHIR Standard | |
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietfrom the FHIR Standard | |
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyfrom the FHIR Standard | |
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsfrom the FHIR Standard | |
| Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-dispositionfrom the FHIR Standard | |
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1from the FHIR Standard | |
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typefrom the FHIR Standard |
This structure is derived from Encounter
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children |
| class |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode |
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter |
0..* | Encounter | An interaction during which services are provided to the patient | |
| language |
0..0 | |||
| statusHistory |
0..0 | |||
| classHistory |
0..0 | |||
| type |
0..0 | |||
| serviceType |
0..0 | |||
| priority |
0..0 | |||
| subject |
0..0 | |||
| episodeOfCare |
0..0 | |||
| basedOn |
0..0 | |||
| participant |
0..0 | |||
| appointment |
0..0 | |||
| length |
0..0 | |||
| reasonCode |
0..0 | |||
| reasonReference |
0..0 | |||
| diagnosis |
0..0 | |||
| account |
0..0 | |||
| hospitalization |
0..0 | |||
| location |
0..0 | |||
| serviceProvider |
0..0 | |||
| partOf |
0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | |
| contained |
0..* | Resource | Contained, inline Resources | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known |
| status |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
| class |
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
| period |
0..1 | Period | The start and end time of the encounter | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard | |
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourcefrom the FHIR Standard | |
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietfrom the FHIR Standard | |
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyfrom the FHIR Standard | |
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsfrom the FHIR Standard | |
| Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-dispositionfrom the FHIR Standard | |
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1from the FHIR Standard | |
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typefrom the FHIR Standard |
This structure is derived from Encounter
Other representations of profile: CSV, Excel, Schematron