Pan-Canadian eReferral-eConsult (CA:eReC) v1.3.0-DFT-preBallot
1.3.0-dft-preBallot 
DFT - The specification is currently in development and subject to change. For a full list of available versions, see the Directory of published versions
Appointment (CA:eReC)
Many ValueSet and CodeSystem bindings in this guide link to resources hosted on the Canada Health Infoway Terminology Service (Ontoserver). If you are redirected to a login page: This is expected and you are being directed to Infoway’s secure environment. To access these resources: You’ll need an InfoCentral Account.
Links
Profile
Derived from
http://hl7.org/fhir/StructureDefinition/Appointment
Description
The resource involves booking one (or a series) of appointment(s) between the patient and the practitioner(s) for a specific date/time. The encounter may be a scheduled referral or an econsult.
References to this resource
Resource Content
| Appointment | C | Appointment | |
| id | Σ | 0..1 | string |
| meta | S Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | S Σ | 0..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | S | 0..1 | Narrative |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| AppointmentClass | S C | 0..* | Extension(CodeableConcept) |
| id | 0..1 | string | |
| extension | C | 0..0 | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 0..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| VirtualService | S C | 0..* | Extension(Complex) |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | S Σ | 1..* | Identifier |
| status | S Σ ?! | 1..1 | codeBinding |
| cancelationReason | Σ | 0..1 | CodeableConcept |
| serviceCategory | Σ | 0..* | CodeableConcept |
| serviceType | Σ | 0..* | CodeableConcept |
| specialty | Σ | 0..* | CodeableConceptBinding |
| appointmentType | Σ | 0..1 | CodeableConceptBinding |
| reasonCode | Σ | 0..* | CodeableConceptBinding |
| reasonReference | C | 0..* | Reference(Condition | ImmunizationRecommendation | Observation | Procedure) |
| priority | 0..1 | unsignedInt | |
| description | S | 0..1 | string |
| supportingInformation | C | 0..* | Reference(Resource) |
| start | S Σ | 0..1 | instant |
| end | Σ | 0..1 | instant |
| minutesDuration | 0..1 | positiveInt | |
| slot | C | 0..* | Reference(Slot) |
| created | S | 0..1 | dateTime |
| comment | S | 0..1 | string |
| patientInstruction | 0..1 | string | |
| basedOn | S C | 1..1 | Reference(ServiceRequest) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | S Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | S Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | S Σ ?! | 1..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| participant | S C | 1..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| type | S Σ | 0..* | CodeableConceptBinding |
| actor | S Σ C | 0..1 | Reference(Location | Patient | PractitionerRole) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | S Σ C | 0..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | S Σ | 0..1 | Identifier |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| use | Σ ?! | 0..1 | codeBinding |
| type | Σ | 0..1 | CodeableConceptBinding |
| system | S Σ | 1..1 | uri |
| value | S Σ | 1..1 | string |
| period | Σ C | 0..1 | Period |
| assigner | Σ C | 0..1 | Reference(Organization) |
| display | Σ | 0..1 | string |
| required | Σ | 0..1 | codeBinding |
| status | Σ | 1..1 | codeBinding |
| period | C | 0..1 | Period |
| requestedPeriod | C | 0..* | Period |
| Appointment | Appointment | ||
| meta | S | ||
| profile | S | ||
| text | S | ||
| extension | |||
| AppointmentClass | S | 0..* | Extension(CodeableConcept) |
| extension | ..0 | ||
| value[x] | Binding | ||
| VirtualService | S | 0..* | Extension(Complex) |
| identifier | S | 1.. | |
| status | S | ||
| description | S | ||
| start | S | ||
| end | |||
| minutesDuration | |||
| created | S | ||
| comment | S | ||
| patientInstruction | |||
| basedOn | S | 1..1 | Reference(ServiceRequest) |
| reference | S | ||
| identifier | S | ||
| use | S | 1.. | |
| system | S | 1.. | |
| value | S | 1.. | |
| participant | S | ||
| type | S | ||
| actor | S | Reference(Location | Patient | PractitionerRole) | |
| reference | S | ||
| identifier | S | ||
| system | S | 1.. | |
| value | S | 1.. |
<description value="The resource involves booking one (or a series) of appointment(s) between the patient and the practitioner(s) for a specific date/time. The encounter may be a scheduled referral or an econsult." />
</element>
<comment value="Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to." />
</element>
</element>
</discriminator>
</slicing>
</element>
</type>
</element>
</element>
</binding>
</element>
<profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.virtualService" />
</type>
</element>
</element>
</element>
</element>
</element>
</element>
</element>
</element>
</element>
<comment value="If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field." />
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest" />
</type>
</element>
</element>
</element>
</element>
</element>
</element>
</element>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient" />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole" />
<targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Location" />
</type>
</element>
</element>
</element>
</element>
</element>
</differential>
</StructureDefinition>
{
"description": "The resource involves booking one (or a series) of appointment(s) between the patient and the practitioner(s) for a specific date/time. The encounter may be a scheduled referral or an econsult.",
{
},
{
"comment": "Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to.",
},
{
},
{
}
},
{
{
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class"
]
}
],
},
{
},
{
}
},
{
{
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.virtualService"
]
}
],
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
"comment": "If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field."
},
{
{
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest"
]
}
],
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
{
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient",
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole",
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Location"
]
}
],
},
{
},
{
},
{
},
{
}
]
}
}
Usage
The Appointment resource is used to represent a meeting planned in response to a ServiceRequest. References to other resources are used to convey the details of the appointment including ServiceRequest the appointment is based on (Appointment.basedOn) and participants (Appointment.participant.actor) in the appointment such as a Patient, PractitionerRole, or HealthcareService. Systems SHALL support start and SHALL support one of end or minutesDuration or both.
Note: see "Slimming Rules", for how references to ServiceRequest within messages sent from Target Systems (eReC Performer and eReC Informer) may be simplified
Notes
.extension:AppointmentClass
- MAY be used to specify the class of the Appointment (e.g. a virtual visit)
.extension:VirtualService
- MAY be used to provide connection details for a virtual visit
.identifier
- SHALL be populated to share business identifers used to reference this resource in subsequent messages
identifier.systemandidentifier.valueSHALL be mustSupport whenever there is a reference or identifier present
.status
- Typically populated with "booked" (or "cancelled" if unbooked)
.description
- Title of the appointment (e.g. the Subject on an appointment in MS Outlook)
.start
- Populate with the appointment start time
- Format: YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z).
.end
- 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported
- Populate with the appointment end time
- Format: YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z).
.minutesDuration
- 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported
- Duration of appointment in minutes
- Populate with a positive integer
.created
- Populate with the date that this appointment was initially created (NOT the time of the appointment itself)
.comment
- Additional comments and details about the appointment (i.e. the Body of an appointment in MS Outlook)
.patientInstruction
- Detailed information and instructions for the patient
- If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field.
.basedOn
- used to associate the Appointment with the ServiceRequest being performed
- SHALL be populated with a Reference to the resource
- if the Appointment is being transmitted via messaging, this element SHALL be populated with either:
- a
.referenceto a resource included in the message as aBundle.entry, or - an
.identifierpopulated with theuse,systemandvalueelements populated with the officialServiceRequest.identifierreceived from the Source System
- a
.participant
- Repeating element identifies one or more participants in the appointment where
.participant.typeis a value from ParticipantType (extensible).participant.actora reference to one of:- the Patient being seen > SHALL be the same as the
ServiceRequest.subject - the PractitionerRole seeing the patient
- the Location of the appointment
- the Patient being seen > SHALL be the same as the
.participant.statusis expected to be "accepted" for a booked appointment
- If an Appointment is being transmitted via messaging, referenced Patient, PractitionerRole and Location resources SHALL
.referencethe resource to included in the message as aBundle.entry