MediRecords FHIR Implementation Guide
1.4.1 - release
| Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-encounter-admission |
| Version: | 1.4.1 |
| Name: | MREncounterAdmission |
| Title: | MR Encounter Admission |
| Status: | Active as of 2024-10-28 02:34:31+0000 |
| Definition: | MediRecords Admission Encounter profile to record visit related details for a patient in context of an hospital admission. |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-encounter-admission
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseEncounter
Summary
Mandatory: 3 elements (34 nested mandatory elements)
Must-Support: 30 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter | C | 0..* | AUBaseEncounter | MediRecords Admission Encounter inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished' |
  meta | ||||
  lastUpdated | S | 0..1 | instant | When the resource version last changed |
  plannedStartDate | S | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate |
| plannedEndDate | S | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate |
 valueDateTime | C | 1..1 | dateTime | The planned end date (or discharge date) of the encounter in the format YYYY-MM-DD inv-mr-date-format-01: Date must be in YYYY-MM-DD format |
| modeOfArrival | S | 0..1 | Coding | Transfer mode for the inpatient admission URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility. |
| valueCoding | 1..1 | Coding | Value of extension Binding: MediRecords Transfer Mode (extensible) | |
| reasonCancelled | S | 0..1 | CodeableConcept | Reason code for admission cancellation URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled |
 valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
 coding | 0..0 | |||
| text | 1..1 | string | Plain text representation of the concept Max Length: 500 | |
| comment | S | 0..1 | string | Comment related to the Encounter URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext |
 Slices for identifier | 0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by pattern:type | |
 identifier:visit-number | S | 0..1 | Identifier | Visit number |
 type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: VN | |
 system | 1..1 | uri | Unique tenant identifier in the form 'urn:uuid:<<tenant-guid>>'. | |
| value | 1..1 | string | Admission identifier (visit number) | |
| assigner | ||||
| display | 1..1 | string | Name of tenant | |
| status | S | 1..1 | code | planned | in-progress | finished | cancelled Binding: MediRecords Admission Encounter Status (required) |
| class | S | 1..1 | Coding | IMP | EMER Binding: MediRecords Admission Encounter Class (required) |
| priority | S | 0..1 | CodeableConcept | Emergency triage priority Binding: MediRecords Triage Priority (extensible) |
| text | 1..1 | string | Plain text representation of the concept | |
 subject | S | 1..1 | Reference(MR Patient) | The patient present at the encounter |
| Slices for participant | 0..* | BackboneElement | This is about the participant who is the performer Slice: Unordered, Open by pattern:type | |
 participant:referring | S | 0..1 | BackboneElement | Referring doctor |
 type | 1..* | CodeableConcept | Referring doctor role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |
| individual | S | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | Referring doctor as user Practitioner or external PractitionerRole Contact |
| reference | 1..1 | string | Relative reference to Referring doctor | |
| display | 0..1 | string | Referring doctor name | |
| participant:attending | S | 0..1 | BackboneElement | Attending doctor |
| type | 1..* | CodeableConcept | Attending doctor role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND | |
| individual | S | 1..1 | Reference(MR Practitioner) | Attending doctor as user Practitioner |
| reference | 1..1 | string | Relative reference to Attending doctor | |
| display | 0..1 | string | Attending provider name | |
| participant:anaesthetist | S | 0..1 | BackboneElement | Anaesthetist |
| type | 1..* | CodeableConcept | Anaesthetist role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88189002 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Anaesthesiologist | |
| individual | S | 1..1 | Reference(MR Practitioner) | Anaesthetist as user Practitioner |
| reference | 1..1 | string | Relative reference to Anaesthetist | |
| display | 0..1 | string | Anaesthetist name | |
| participant:usual-gp | S | 0..1 | BackboneElement | General Practitioner |
| type | 1..* | CodeableConcept | GP role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59058001 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: General physician | |
| individual | S | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | GP as user Practitioner or external PractitionerRole Contact |
| reference | 1..1 | string | Relative reference to GP | |
| display | 0..1 | string | GP name | |
| appointment | S | 0..1 | Reference(Appointment) | Preadmission appointment |
| identifier | 1..1 | Identifier | Preadmission appointment identifier | |
| system | 1..1 | uri | Facility unique identifier in the form 'urn:uuid:<<practice-guid>>'. | |
| value | 1..1 | string | Appointment unique identifier | |
| assigner | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| display | 1..1 | string | Facility name | |
| period | 0..1 | Period | The actual start and end time of the encounter | |
| start | S | 1..1 | dateTime | The actual start time of the encounter |
| end | S | 0..1 | dateTime | The actual end time of the encounter |
| length | S | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) |
| code | 1..1 | code | d (days) Fixed Value: d | |
| reasonCode | S | 0..1 | CodeableConcept | Chief complaint of the patient for this encounter Binding: EncounterReasonCodes (extensible) |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| text | 1..1 | string | Plain text representation of the concept | |
| hospitalization | ||||
| admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (extensible) |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| text | 1..1 | string | Plain text representation of the concept | |
| destination | S | 0..1 | Reference(MR Organisation | MR Organisation Service Provider) | Facility or external service provider to which the patient is discharged |
| reference | 1..1 | string | Relative reference to destination facility/service provider | |
| display | 0..1 | string | Facility or external service provider name | |
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| text | 1..1 | string | Plain text representation of the concept | |
| location | 0..1 | BackboneElement | Current location of patient within the facility | |
| location | S | 1..1 | Reference(MR Location Admission) | Venue of where the encounter took place |
| reference | 1..1 | string | Relative reference to most specific Location of type Bed, Room or Ward | |
| display | 0..1 | string | Contatenated description of location heirarchy including ward, bed and room | |
| physicalType | S | 1..1 | CodeableConcept | wa (Ward) | ro (Room) | bd (Bed) Binding: MediRecords Admission Encounter Location PhysicalType (required) |
| serviceProvider | S | 1..1 | Reference(MR Organisation) | Facility where the patient is admitted |
| reference | 1..1 | string | Relative reference to facility | |
| display | 0..1 | string | Facility name | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | C | 0..* | AUBaseEncounter | MediRecords Admission Encounter inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished' | ||||
 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 | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| encounterDescription | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |||||
| associatedHealthcareService | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |||||
| plannedStartDate | S | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate | ||||
| plannedEndDate | S | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate" | |||||
| Slices for value[x] | 1..1 | dateTime | The planned end date/time (or discharge date) of the encounter Slice: Unordered, Closed by type:$this | |||||
 value[x]:valueDateTime | C | 1..1 | dateTime | The planned end date (or discharge date) of the encounter in the format YYYY-MM-DD inv-mr-date-format-01: Date must be in YYYY-MM-DD format | ||||
| modeOfArrival | S | 0..1 | Coding | Transfer mode for the inpatient admission URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility. | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival" | |||||
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility. | |||||
| value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: MediRecords Transfer Mode (extensible) | |||||
| reasonCancelled | S | 0..1 | CodeableConcept | Reason code for admission cancellation URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| text | Σ | 1..1 | string | Plain text representation of the concept Max Length: 500 | ||||
| comment | S | 0..1 | string | Comment related to the Encounter URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext | ||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by pattern:type | ||||
| identifier:visit-number | SΣ | 0..1 | Identifier | Visit number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: VN | |||||
| 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 | |||||
| system | Σ | 1..1 | uri | Unique tenant identifier in the form 'urn:uuid:<<tenant-guid>>'. Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Admission identifier (visit number) Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 1..1 | string | Name of tenant | ||||
| status | ?!SΣ | 1..1 | code | planned | in-progress | finished | cancelled Binding: MediRecords Admission Encounter Status (required) | ||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified status | |||||
| class | SΣ | 1..1 | Coding | IMP | EMER Binding: MediRecords Admission Encounter Class (required) | ||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified class | |||||
| type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
| serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
| priority | S | 0..1 | CodeableConcept | Emergency triage priority Binding: MediRecords Triage Priority (extensible) | ||||
| 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 | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| subject | SΣ | 1..1 | Reference(MR Patient) | The patient present at the encounter | ||||
| episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| Slices for participant | Σ | 0..* | BackboneElement | This is about the participant who is the performer Slice: Unordered, Open by pattern:type | ||||
| participant:All Slices | Content/Rules for all slices | |||||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| participant:referring | SΣ | 0..1 | BackboneElement | Referring doctor | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | Referring doctor role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
| 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 | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | Referring doctor as user Practitioner or external PractitionerRole Contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to Referring doctor | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Referring doctor name | ||||
| participant:attending | SΣ | 0..1 | BackboneElement | Attending doctor | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | Attending doctor role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND | |||||
| 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 | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner) | Attending doctor as user Practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to Attending doctor | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Attending provider name | ||||
| participant:anaesthetist | SΣ | 0..1 | BackboneElement | Anaesthetist | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | Anaesthetist role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88189002 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Anaesthesiologist | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner) | Anaesthetist as user Practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to Anaesthetist | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Anaesthetist name | ||||
| participant:usual-gp | SΣ | 0..1 | BackboneElement | General Practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | GP role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59058001 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: General physician | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | GP as user Practitioner or external PractitionerRole Contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to GP | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | GP name | ||||
| appointment | SΣ | 0..1 | Reference(Appointment) | Preadmission appointment | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Preadmission appointment identifier | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | Facility unique identifier in the form 'urn:uuid:<<practice-guid>>'. Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Appointment unique identifier Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 1..1 | string | Facility name | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| period | 0..1 | Period | The actual start and end time of the encounter | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 1..1 | dateTime | The actual start time of the encounter | ||||
| end | SΣC | 0..1 | dateTime | The actual end time of the encounter | ||||
| length | S | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code | Σ | 1..1 | code | d (days) Fixed Value: d | ||||
| reasonCode | SΣ | 0..1 | CodeableConcept | Chief complaint of the patient for this encounter Binding: EncounterReasonCodes (extensible) | ||||
| 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 | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
| diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (extensible) | ||||
| 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 | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination | S | 0..1 | Reference(MR Organisation | MR Organisation Service Provider) | Facility or external service provider to which the patient is discharged | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to destination facility/service provider | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Facility or external service provider name | ||||
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode Binding: Separation Mode  (extensible) | ||||
| 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 | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| location | 0..1 | BackboneElement | Current location of patient within the facility | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location | S | 1..1 | Reference(MR Location Admission) | Venue of where the encounter took place | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to most specific Location of type Bed, Room or Ward | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Contatenated description of location heirarchy including ward, bed and room | ||||
| status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType | S | 1..1 | CodeableConcept | wa (Ward) | ro (Room) | bd (Bed) Binding: MediRecords Admission Encounter Location PhysicalType (required) | ||||
| period | 0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider | S | 1..1 | Reference(MR Organisation) | Facility where the patient is admitted | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to facility | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Facility name | ||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | 0..* | AUBaseEncounter | MediRecords Admission Encounter | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| plannedStartDate | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate | |
| plannedEndDate | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate | |
| modeOfArrival | 0..1 | Coding | Transfer mode for the inpatient admission URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility. | |
| reasonCancelled | 0..1 | CodeableConcept | Reason code for admission cancellation URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled | |
| comment | 0..1 | string | Comment related to the Encounter URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext | |
| identifier:visit-number | Σ | 0..1 | Identifier | Visit number |
| status | ?!Σ | 1..1 | code | planned | in-progress | finished | cancelled Binding: MediRecords Admission Encounter Status (required) |
| class | Σ | 1..1 | Coding | IMP | EMER Binding: MediRecords Admission Encounter Class (required) |
| priority | 0..1 | CodeableConcept | Emergency triage priority Binding: MediRecords Triage Priority (extensible) | |
| subject | Σ | 1..1 | Reference(MR Patient) | The patient present at the encounter |
| participant:referring | Σ | 0..1 | BackboneElement | Referring doctor |
| individual | Σ | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | Referring doctor as user Practitioner or external PractitionerRole Contact |
| participant:attending | Σ | 0..1 | BackboneElement | Attending doctor |
| individual | Σ | 1..1 | Reference(MR Practitioner) | Attending doctor as user Practitioner |
| participant:anaesthetist | Σ | 0..1 | BackboneElement | Anaesthetist |
| individual | Σ | 1..1 | Reference(MR Practitioner) | Anaesthetist as user Practitioner |
| participant:usual-gp | Σ | 0..1 | BackboneElement | General Practitioner |
| individual | Σ | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | GP as user Practitioner or external PractitionerRole Contact |
| appointment | Σ | 0..1 | Reference(Appointment) | Preadmission appointment |
| period | 0..1 | Period | The actual start and end time of the encounter | |
| start | ΣC | 1..1 | dateTime | The actual start time of the encounter |
| end | ΣC | 0..1 | dateTime | The actual end time of the encounter |
| length | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |
| reasonCode | Σ | 0..1 | CodeableConcept | Chief complaint of the patient for this encounter Binding: EncounterReasonCodes (extensible) |
| hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |
| admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (extensible) | |
| destination | 0..1 | Reference(MR Organisation | MR Organisation Service Provider) | Facility or external service provider to which the patient is discharged | |
| dischargeDisposition | 0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) | |
| location | 0..1 | BackboneElement | Current location of patient within the facility | |
| location | 1..1 | Reference(MR Location Admission) | Venue of where the encounter took place | |
| physicalType | 1..1 | CodeableConcept | wa (Ward) | ro (Room) | bd (Bed) Binding: MediRecords Admission Encounter Location PhysicalType (required) | |
| serviceProvider | 1..1 | Reference(MR Organisation) | Facility where the patient is admitted | |
| Documentation for this format | ||||
This structure is derived from AUBaseEncounter
Summary
Mandatory: 3 elements (34 nested mandatory elements)
Must-Support: 30 elements
Fixed Value: 1 element
Prohibited: 1 element
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 AUBaseEncounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | C | 0..* | AUBaseEncounter | MediRecords Admission Encounter inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished' |
| meta | ||||
| lastUpdated | S | 0..1 | instant | When the resource version last changed |
| plannedStartDate | S | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate |
| plannedEndDate | S | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate |
| valueDateTime | C | 1..1 | dateTime | The planned end date (or discharge date) of the encounter in the format YYYY-MM-DD inv-mr-date-format-01: Date must be in YYYY-MM-DD format |
| modeOfArrival | S | 0..1 | Coding | Transfer mode for the inpatient admission URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility. |
| valueCoding | 1..1 | Coding | Value of extension Binding: MediRecords Transfer Mode (extensible) | |
| reasonCancelled | S | 0..1 | CodeableConcept | Reason code for admission cancellation URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
| coding | 0..0 | |||
| text | 1..1 | string | Plain text representation of the concept Max Length: 500 | |
| comment | S | 0..1 | string | Comment related to the Encounter URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext |
| Slices for identifier | 0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by pattern:type | |
| identifier:visit-number | S | 0..1 | Identifier | Visit number |
| type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: VN | |
| system | 1..1 | uri | Unique tenant identifier in the form 'urn:uuid:<<tenant-guid>>'. | |
| value | 1..1 | string | Admission identifier (visit number) | |
| assigner | ||||
| display | 1..1 | string | Name of tenant | |
| status | S | 1..1 | code | planned | in-progress | finished | cancelled Binding: MediRecords Admission Encounter Status (required) |
| class | S | 1..1 | Coding | IMP | EMER Binding: MediRecords Admission Encounter Class (required) |
| priority | S | 0..1 | CodeableConcept | Emergency triage priority Binding: MediRecords Triage Priority (extensible) |
| text | 1..1 | string | Plain text representation of the concept | |
| subject | S | 1..1 | Reference(MR Patient) | The patient present at the encounter |
| Slices for participant | 0..* | BackboneElement | This is about the participant who is the performer Slice: Unordered, Open by pattern:type | |
| participant:referring | S | 0..1 | BackboneElement | Referring doctor |
| type | 1..* | CodeableConcept | Referring doctor role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |
| individual | S | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | Referring doctor as user Practitioner or external PractitionerRole Contact |
| reference | 1..1 | string | Relative reference to Referring doctor | |
| display | 0..1 | string | Referring doctor name | |
| participant:attending | S | 0..1 | BackboneElement | Attending doctor |
| type | 1..* | CodeableConcept | Attending doctor role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND | |
| individual | S | 1..1 | Reference(MR Practitioner) | Attending doctor as user Practitioner |
| reference | 1..1 | string | Relative reference to Attending doctor | |
| display | 0..1 | string | Attending provider name | |
| participant:anaesthetist | S | 0..1 | BackboneElement | Anaesthetist |
| type | 1..* | CodeableConcept | Anaesthetist role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88189002 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Anaesthesiologist | |
| individual | S | 1..1 | Reference(MR Practitioner) | Anaesthetist as user Practitioner |
| reference | 1..1 | string | Relative reference to Anaesthetist | |
| display | 0..1 | string | Anaesthetist name | |
| participant:usual-gp | S | 0..1 | BackboneElement | General Practitioner |
| type | 1..* | CodeableConcept | GP role type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59058001 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: General physician | |
| individual | S | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | GP as user Practitioner or external PractitionerRole Contact |
| reference | 1..1 | string | Relative reference to GP | |
| display | 0..1 | string | GP name | |
| appointment | S | 0..1 | Reference(Appointment) | Preadmission appointment |
| identifier | 1..1 | Identifier | Preadmission appointment identifier | |
| system | 1..1 | uri | Facility unique identifier in the form 'urn:uuid:<<practice-guid>>'. | |
| value | 1..1 | string | Appointment unique identifier | |
| assigner | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| display | 1..1 | string | Facility name | |
| period | 0..1 | Period | The actual start and end time of the encounter | |
| start | S | 1..1 | dateTime | The actual start time of the encounter |
| end | S | 0..1 | dateTime | The actual end time of the encounter |
| length | S | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) |
| code | 1..1 | code | d (days) Fixed Value: d | |
| reasonCode | S | 0..1 | CodeableConcept | Chief complaint of the patient for this encounter Binding: EncounterReasonCodes (extensible) |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| text | 1..1 | string | Plain text representation of the concept | |
| hospitalization | ||||
| admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (extensible) |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| text | 1..1 | string | Plain text representation of the concept | |
| destination | S | 0..1 | Reference(MR Organisation | MR Organisation Service Provider) | Facility or external service provider to which the patient is discharged |
| reference | 1..1 | string | Relative reference to destination facility/service provider | |
| display | 0..1 | string | Facility or external service provider name | |
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode |
| coding | 0..1 | Coding | Code defined by a terminology system | |
| text | 1..1 | string | Plain text representation of the concept | |
| location | 0..1 | BackboneElement | Current location of patient within the facility | |
| location | S | 1..1 | Reference(MR Location Admission) | Venue of where the encounter took place |
| reference | 1..1 | string | Relative reference to most specific Location of type Bed, Room or Ward | |
| display | 0..1 | string | Contatenated description of location heirarchy including ward, bed and room | |
| physicalType | S | 1..1 | CodeableConcept | wa (Ward) | ro (Room) | bd (Bed) Binding: MediRecords Admission Encounter Location PhysicalType (required) |
| serviceProvider | S | 1..1 | Reference(MR Organisation) | Facility where the patient is admitted |
| reference | 1..1 | string | Relative reference to facility | |
| display | 0..1 | string | Facility name | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | C | 0..* | AUBaseEncounter | MediRecords Admission Encounter inv-mr-consult-period-end-01: Medirecords supports period.end for only 'finished' consultation status inv-mr-consult-period-end-02: Medirecords expects period.end value if the consultation status is set to 'finished' | ||||
| 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 | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| encounterDescription | 0..1 | string | Description, overview or summary of an encounter URL: http://hl7.org.au/fhir/StructureDefinition/encounter-description | |||||
| associatedHealthcareService | 0..* | Reference(HealthcareService) | Associated healthcare service URL: http://hl7.org.au/fhir/StructureDefinition/associated-healthcareservice | |||||
| plannedStartDate | S | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedStartDate | ||||
| plannedEndDate | S | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Encounter.plannedEndDate" | |||||
| Slices for value[x] | 1..1 | dateTime | The planned end date/time (or discharge date) of the encounter Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueDateTime | C | 1..1 | dateTime | The planned end date (or discharge date) of the encounter in the format YYYY-MM-DD inv-mr-date-format-01: Date must be in YYYY-MM-DD format | ||||
| modeOfArrival | S | 0..1 | Coding | Transfer mode for the inpatient admission URL: http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility. | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/encounter-modeOfArrival" | |||||
| Slices for value[x] | 1..1 | Coding | Value of extension Slice: Unordered, Closed by type:$this Binding: hl7VS-modeOfArrivalCode (example): The method that the patient arrived at the facility. | |||||
| value[x]:valueCoding | 1..1 | Coding | Value of extension Binding: MediRecords Transfer Mode (extensible) | |||||
| reasonCancelled | S | 0..1 | CodeableConcept | Reason code for admission cancellation URL: http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/encounter-reasonCancelled" | |||||
| Slices for value[x] | 1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| text | Σ | 1..1 | string | Plain text representation of the concept Max Length: 500 | ||||
| comment | S | 0..1 | string | Comment related to the Encounter URL: https://fhir.medirecords.com/StructureDefinition/mr-comment-note-ext | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known Slice: Unordered, Open by pattern:type | ||||
| identifier:visit-number | SΣ | 0..1 | Identifier | Visit number | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 1..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. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: VN | |||||
| 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 | |||||
| system | Σ | 1..1 | uri | Unique tenant identifier in the form 'urn:uuid:<<tenant-guid>>'. Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Admission identifier (visit number) Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 1..1 | string | Name of tenant | ||||
| status | ?!SΣ | 1..1 | code | planned | in-progress | finished | cancelled Binding: MediRecords Admission Encounter Status (required) | ||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified status | |||||
| class | SΣ | 1..1 | Coding | IMP | EMER Binding: MediRecords Admission Encounter Class (required) | ||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified class | |||||
| type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
| serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
| priority | S | 0..1 | CodeableConcept | Emergency triage priority Binding: MediRecords Triage Priority (extensible) | ||||
| 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 | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| subject | SΣ | 1..1 | Reference(MR Patient) | The patient present at the encounter | ||||
| episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| Slices for participant | Σ | 0..* | BackboneElement | This is about the participant who is the performer Slice: Unordered, Open by pattern:type | ||||
| participant:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| participant:referring | SΣ | 0..1 | BackboneElement | Referring doctor | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | Referring doctor role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
| 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 | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | Referring doctor as user Practitioner or external PractitionerRole Contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to Referring doctor | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Referring doctor name | ||||
| participant:attending | SΣ | 0..1 | BackboneElement | Attending doctor | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | Attending doctor role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ATND | |||||
| 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 | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner) | Attending doctor as user Practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to Attending doctor | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Attending provider name | ||||
| participant:anaesthetist | SΣ | 0..1 | BackboneElement | Anaesthetist | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | Anaesthetist role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 88189002 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Anaesthesiologist | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner) | Anaesthetist as user Practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to Anaesthetist | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Anaesthetist name | ||||
| participant:usual-gp | SΣ | 0..1 | BackboneElement | General Practitioner | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 1..* | CodeableConcept | GP role type Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 59058001 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: General physician | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | SΣ | 1..1 | Reference(MR Practitioner | MR PractitionerRole Contact) | GP as user Practitioner or external PractitionerRole Contact | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to GP | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | GP name | ||||
| appointment | SΣ | 0..1 | Reference(Appointment) | Preadmission appointment | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 1..1 | Identifier | Preadmission appointment identifier | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 1..1 | uri | Facility unique identifier in the form 'urn:uuid:<<practice-guid>>'. Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | Appointment unique identifier Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 1..1 | string | Facility name | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| period | 0..1 | Period | The actual start and end time of the encounter | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 1..1 | dateTime | The actual start time of the encounter | ||||
| end | SΣC | 0..1 | dateTime | The actual end time of the encounter | ||||
| length | S | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value | Σ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit | Σ | 0..1 | string | Unit representation | ||||
| system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code | Σ | 1..1 | code | d (days) Fixed Value: d | ||||
| reasonCode | SΣ | 0..1 | CodeableConcept | Chief complaint of the patient for this encounter Binding: EncounterReasonCodes (extensible) | ||||
| 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 | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
| diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource | S | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (extensible) | ||||
| 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 | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination | S | 0..1 | Reference(MR Organisation | MR Organisation Service Provider) | Facility or external service provider to which the patient is discharged | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to destination facility/service provider | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Facility or external service provider name | ||||
| dischargeDisposition | S | 0..1 | CodeableConcept | Separation Mode Binding: Separation Mode (extensible) | ||||
| 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 | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
| text | Σ | 1..1 | string | Plain text representation of the concept | ||||
| location | 0..1 | BackboneElement | Current location of patient within the facility | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location | S | 1..1 | Reference(MR Location Admission) | Venue of where the encounter took place | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to most specific Location of type Bed, Room or Ward | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Contatenated description of location heirarchy including ward, bed and room | ||||
| status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType | S | 1..1 | CodeableConcept | wa (Ward) | ro (Room) | bd (Bed) Binding: MediRecords Admission Encounter Location PhysicalType (required) | ||||
| period | 0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider | S | 1..1 | Reference(MR Organisation) | Facility where the patient is admitted | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 1..1 | string | Relative reference to facility | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Facility name | ||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code | URI | |||
| Encounter.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Encounter.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Encounter.extension:modeOfArrival.value[x] | example | Hl7VSModeOfArrivalCodehttp://terminology.hl7.org/ValueSet/v2-0430 | ||||
| Encounter.extension:modeOfArrival.value[x]:valueCoding | extensible | MRTransferModehttps://fhir.medirecords.com/ValueSet/mr-transfer-modefrom this IG | ||||
| Encounter.identifier:visit-number.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Encounter.identifier:visit-number.type | extensible | Pattern: VNhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Encounter.identifier:visit-number.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.status | required | MREncounterAdmissionStatushttps://fhir.medirecords.com/ValueSet/mr-encounter-admission-statusfrom this IG | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1from the FHIR Standard | ||||
| Encounter.class | required | MREncounterAdmissionClasshttps://fhir.medirecords.com/ValueSet/mr-encounter-admission-classfrom this IG | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-typefrom the FHIR Standard | ||||
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | ||||
| Encounter.priority | extensible | MRTriagePriorityhttps://fhir.medirecords.com/ValueSet/mr-triage-priorityfrom this IG | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Encounter.participant:referring.type | extensible | Pattern: REFhttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Encounter.participant:referring.individual.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.participant:attending.type | extensible | Pattern: ATNDhttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Encounter.participant:attending.individual.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.participant:anaesthetist.type | extensible | Pattern: SNOMED CT code 88189002("Anaesthesiologist")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Encounter.participant:anaesthetist.individual.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.participant:usual-gp.type | extensible | Pattern: SNOMED CT code 59058001("General physician")http://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Encounter.participant:usual-gp.individual.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.appointment.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Encounter.appointment.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Encounter.appointment.identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.length.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| Encounter.reasonCode | extensible | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-rolefrom the FHIR Standard | ||||
| Encounter.hospitalization.admitSource | extensible | 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.destination.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.hospitalization.dischargeDisposition | extensible | SeparationMode (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/separation-mode-1)https://healthterminologies.gov.au/fhir/ValueSet/separation-mode-1 | ||||
| Encounter.location.location.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1from the FHIR Standard | ||||
| Encounter.location.physicalType | required | MREncounterAdmissionLocationPhysicalTypehttps://fhir.medirecords.com/ValueSet/mr-encounter-admission-locationPhysicalTypefrom this IG | ||||
| Encounter.serviceProvider.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-mr-consult-period-end-01 | error | Encounter | Medirecords supports period.end for only 'finished' consultation status : period.end.exists() implies (status = 'finished') | |
| inv-mr-consult-period-end-02 | error | Encounter | Medirecords expects period.end value if the consultation status is set to 'finished' : status = 'finished' implies (period.end.exists()) | |
| inv-mr-date-format-01 | error | Encounter.extension:plannedEndDate.value[x]:valueDateTime | Date must be in YYYY-MM-DD format : ($this as dateTime).toString().matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$') |