A: Primary Flow
The following sequence diagram shows the primary messaging flow starting from the Requester HCP (Referring Provider) sending a service request to the CAT until the Performer HCP completes the service.
See Participants for more information.
Element and Value
The following table includes elements for Communication, DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole resources. The elements for remaining resources are listed in appropriate steps below.
| Element |
Value |
| Communication.id |
UUID |
| Communication.basedOn.identifier.value |
ServiceRequest provincial identifier |
| Communication.basedOn.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| Communication.inResponseTo.reference |
Communication UUID - if applicable |
| Communication.inResponseTo.type |
"Communication" - if applicable |
| Communication.status |
"completed" |
| Communication.category |
as appropriate |
| Communication.subject.identifier.value |
Patient identifier |
| Communication.subject.identifier.system |
as appropriate |
| Communication.sent |
current date/time |
| Communication.recipient |
as appropriate |
| Communication.sender |
as appropriate |
| Communication.payload.contentString |
1) string AND/OR |
| Communication.payload.contentReference |
2) DocumentReference UUID |
| DocumentReference.id |
UUID |
| DocumentReference.meta.lastUpdated |
date/time |
| DocumentReference.identifier.value |
UUID |
| DocumentReference.identifier.system |
"urn:ietf:rfc:3986" |
| DocumentReference.status |
"current" |
| DocumentReference.type |
"57133-1" (Referral note) |
| DocumentReference.subject.reference |
Patient UUID |
| DocumentReference.subject.type |
"Patient" |
| DocumentReference.subject.identifier.value |
Patient identifier |
| DocumentReference.subject.identifier.type |
"JHN" |
| DocumentReference.subject.identifier.system |
as appropriate |
| DocumentReference.date |
date/time |
| DocumentReference.content.attachment.contentType |
"application/pdf" |
| DocumentReference.content.attachment.data |
as appropriate |
| DocumentReference.content.attachment.title |
as appropriate |
| DocumentReference.context.related.reference |
ServiceRequest UUID |
| DocumentReference.context.related.type |
"ServiceRequest" |
| DocumentReference.context.related.identifier.value |
ServiceRequest UUID or provincial identifier |
| DocumentReference.context.related.identifier.system |
"urn:ietf:rfc:3986" or "https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| HealthcareService.id |
UUID |
| HealthcareService.meta.lastUpdated |
date/time |
| HealthcareService.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| HealthcareService.identifier.value |
as appropriate |
| HealthcareService.type |
as appropriate |
| HealthcareService.name |
as appropriate |
| HealthcareService.telecom |
as appropriate |
| HealthcareService.providedBy.name |
same as HealthcareService.name |
| HealthcareService.providedBy.contact.name.family |
as appropriate |
| HealthcareService.providedBy.contact.name.given |
as appropriate |
| Location.id |
UUID |
| Location.meta.lastUpdated |
date/time |
| Location.identifier.type |
"FI" |
| Location.identifier.system |
as appropriate |
| Location.identifier.value |
as appropriate |
| Location.name |
as appropriate |
| Location.telecom.system |
"phone" or "fax" |
| Location.telecom.value |
as appropriate |
| Location.address.type |
"physical" |
| Location.address.line |
as appropriate |
| Location.address.city |
as appropriate |
| Location.address.state |
as appropriate |
| Location.address.postalCode |
as appropriate |
| Patient.id |
UUID |
| Patient.meta.lastUpdated |
date/time |
| Patient.identifier.type |
"JHN" |
| Patient.identifier.system |
as appropriate |
| Patient.identifier.assigner.display |
as appropriate |
| Patient.identifier.value |
as appropriate |
| Patient.name.text |
as appropriate |
| Patient.name.family |
as appropriate |
| Patient.name.given |
as appropriate |
| Patient.telecom.system |
"phone" or "fax" |
| Patient.telecom.value |
as appropriate |
| Patient.telecom.use |
"home", "work", or "mobile" |
| Patient.telecom.rank |
as appropriate |
| Patient.gender |
"other" |
| Patient.birthDate |
as appropriate |
| Patient.address.use |
as appropriate or defaults to "home" |
| Patient.address.type |
as appropriate or defaults to "both" |
| Patient.address.line |
as appropriate |
| Patient.address.city |
as appropriate |
| Patient.address.state |
as appropriate |
| Patient.address.postalCode |
as appropriate |
| Patient.address.country |
as appropriate |
| Patient.contact.relationship |
as appropriate |
| Patient.contact.name |
as appropriate |
| Patient.contact.telecom |
as appropriate |
| Patient.contact.address |
as appropriate |
| Patient.extension.individual-recordedSexOrGender |
as appropriate |
| Practitioner.id |
UUID |
| Practitioner.meta.lastUpdated |
date/time |
| Practitioner.identifier.type |
as appropriate |
| Practitioner.identifier.system |
as appropriate |
| Practitioner.identifier.assigner.display |
as appropriate |
| Practitioner.identifier.value |
as appropriate |
| Practitioner.name.family |
as appropriate |
| Practitioner.name.given |
as appropriate |
| PractitionerRole.id |
UUID |
| PractitionerRole.meta.lastUpdated |
date/time |
| PractitionerRole.practitioner.reference |
UUID |
| PractitionerRole.practitioner.type |
"Practitioner" |
| PractitionerRole.practitioner.identifier.type |
"PRN" or "LN" |
| PractitionerRole.practitioner.identifier.system |
as appropriate |
| PractitionerRole.practitioner.identifier.value |
as appropriate |
| PractitionerRole.code |
as appropriate/if available |
| PractitionerRole.specialty |
as appropriate/if available |
| PractitionerRole.location.reference |
UUID/if available |
| PractitionerRole.location.type |
"Location"/if avaiable |
| PractitionerRole.location.identifier.type |
"FI"/if available |
| PractitionerRole.location.identifier.system |
as appropriate/if available |
| PractitionerRole.location.identifier.value |
as appropriate/if available |
Step 1: Requester HCP sends service request to CAT
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"add-service-request" |
| MessageHeader.destination.endpoint |
CAT RMS endpoint |
| MessageHeader.author.reference |
Requester HCP UUID |
| MessageHeader.author.type |
"PractitionerRole" |
| MessageHeader.source.endpoint |
Requester HCP endpoint |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
UUID |
| ServiceRequest.identifier.system |
"urn:ietf:rfc:3986" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as appropriate |
| ServiceRequest.priority |
"routine" (or "urgent" as appropriate) |
| ServiceRequest.priority.extension.subPriority |
"semi-urgent" as appropriate) |
| ServiceRequest.code |
as appropriate |
| ServiceRequest.subject.reference |
UUID |
| ServiceRequest.subject.type |
"Patient" |
| ServiceRequest.authoredOn |
date/time when Requester EMR created service request |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.reference |
CAT UUID |
| ServiceRequest.performer.type |
"HealthcareService" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.reasonCode.text |
as appropriate |
| ServiceRequest.supportingInfo |
as appropriate/needed |
| ServiceRequest.note.text |
N/A |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
"service-provider" and/or "service-location" |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as appropriate |
| ServiceRequest.extension.patientPreference.extension.rationale |
as appropriate |
Step 2: CAT acknowledges service request from Requester HCP
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
Task |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-add-process-request" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.focus |
Task |
| Task.id |
UUID |
| Task.meta.lastUpdated |
date/time |
| Task.identifier.value |
UUID |
| Task.identifier.system |
"urn:ietf:rfc:3986" |
| Task.basedOn.identifier.system |
ServiceRequest UUID |
| Task.basedOn.identifier.value |
"urn:ietf:rfc:3986" |
| Task.status |
"received" |
| Task.businessStatus |
"received" |
| Task.intent |
"proposal" |
| Task.code |
"process-request" |
| Task.authoredOn |
date/time |
| Task.lastModified |
date/time |
| Task.owner.reference |
CAT UUID |
| Task.owner.type |
("HealthcareService") |
Step 4: CAT notifies Requester HCP of creation of referral record
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-add-service-record" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
1) provincial identifier assigned by CAT |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.identifier.value |
2) UUID assigned by Requester HCP EMR |
| ServiceRequest.identifier.system |
"urn:ietf:rfc:3986" |
| ServiceRequest.replaces.identifier.value |
UUID assigned by Requester HCP EMR |
| ServiceRequest.replaces.identifier.system |
"urn:ietf:rfc:3986" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP |
| ServiceRequest.priority |
as received from Requester HCP |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP |
| ServiceRequest.code |
as received from Requester HCP |
| ServiceRequest.subject.identifier.value |
Patient identifier |
| ServiceRequest.subject.identifier.system |
as appropriate |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.reasonCode.text |
as received from Requester HCP |
| ServiceRequest.supportingInfo |
as received from Requester HCP |
| ServiceRequest.note.text |
N/A |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
date/time |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
"referral-received" |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.rationale |
as received from Requester HCP |
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.eventCoding |
"add-service-request" |
| MessageHeader.destination.endpoint |
Performer HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP |
| ServiceRequest.priority |
as received from Requester HCP |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP |
| ServiceRequest.code |
as received from Requester HCP or as assigned by CAT |
| ServiceRequest.subject.reference |
UUID |
| ServiceRequest.subject.type |
"Patient" |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.reference |
Performer HCP UUID |
| ServiceRequest.performer.type |
"PractitionerRole" or "HealthcareService" |
| ServiceRequest.performer.extension.role |
"receiving-provider" or "service-location" |
| ServiceRequest.reasonCode.text |
as received from Requester HCP |
| ServiceRequest.supportingInfo |
as received from Requester HCP |
| ServiceRequest.note.text |
N/A |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
date/time |
| ServiceRequest.extension.referralTimestamp |
"referral-received" |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP |
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-update-service-record" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.reason |
"service-request-assigned" |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP |
| ServiceRequest.priority |
as received from Requester HCP |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP |
| ServiceRequest.code |
as received from Requester HCP or as assigned by CAT |
| ServiceRequest.subject.identifier.value |
Patient identifier |
| ServiceRequest.subject.identifier.system |
as appropriate |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Request HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
1) CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.performer.reference |
2) Performer HCP UUID |
| ServiceRequest.performer.type |
"PractitionerRole" or "HealthcareService" |
| ServiceRequest.performer.extension.role |
"receiving-provider" or "service-location" |
| ServiceRequest.reasonCode.text |
as received from Requester HCP |
| ServiceRequest.supportingInfo |
as received from Requester HCP |
| ServiceRequest.note.text |
N/A |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
date/time |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
"referral-received" |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP |
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
Task |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-add-process-request" |
| MessageHeader.destination.endpoint |
CAT RMS endpoint |
| MessageHeader.source.endpoint |
Performer HCP endpoint |
| MessageHeader.focus |
Task |
| Task.id |
UUID |
| Task.meta.lastUpdated |
date/time |
| Task.identifier.value |
UUID |
| Task.identifier.system |
"urn:ietf:rfc:3986" |
| Task.basedOn.identifier.system |
ServiceRequest UUID |
| Task.basedOn.identifier.value |
"urn:ietf:rfc:3986" |
| Task.status |
"received" |
| Task.businessStatus |
"received" |
| Task.intent |
"proposal" |
| Task.code |
"process-request" |
| Task.authoredOn |
date/time |
| Task.lastModified |
date/time |
| Task.owner.reference |
Performer HCP UUID |
| Task.owner.type |
"PractitionerRole" or "HealthcareService" |
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
Task |
| MessageHeader.id |
UUID |
| MessageHeader.eventCoding |
"notify-update-process-request" |
| MessageHeader.destination.endpoint |
CAT RMS endpoint |
| MessageHeader.author.reference |
Performer HCP UUID |
| MessageHeader.author.type |
"PractitionerRole" |
| MessageHeader.source.endpoint |
Performer HCP endpoint |
| MessageHeader.focus |
Task |
| Task.id.value |
UUID |
| Task.id.system |
"urn:ietf:rfc:3986" |
| Task.identifier.value |
UUID |
| Task.identifier.system |
"urn:ietf:rfc:3986" |
| Task.basedOn.identifier.value |
ServiceRequest provincial identifier |
| Task.basedOn.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| Task.status |
"accepted" |
| Task.businessStatus |
"accepted" |
| Task.intent |
"proposal" |
| Task.code |
"process-request" |
| Task.authoredOn |
date/time |
| Task.lastModified |
date/time |
| Task.owner.reference |
Performer HCP UUID |
| Task.owner.type |
"PractitionerRole" |
Same as Step 10 above with changes as below:
| Element |
Value |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.author.reference |
N/A |
| MessageHeader.author.type |
N/A |
| Task.owner.identifier.value |
CAT identifier (HealthcareService) |
| Task.owner.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
Step 13: CAT notifies Requester HCP of update to referral record (accepted)
Same as Step 10 above with changes as below:
| Element |
Value |
| MessageHeader.eventCoding |
"notify-update-service-record" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.author.reference |
N/A |
| MessageHeader.author.type |
N/A |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| Task.basedOn.reference |
UUID |
| Task.basedOn.type |
"ServiceRequest" |
| Task.owner.identifier.value |
CAT identifier (HealthcareService) |
| Task.owner.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.id |
UUID |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP |
| ServiceRequest.priority |
as received from Requester HCP |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP |
| ServiceRequest.code |
as received from Requester HCP |
| ServiceRequest.subject.identifier.value |
Patient identifier |
| ServiceRequest.subject.identifier.system |
as appropriate |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
1) CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.reference |
2) Performer HCP UUID |
| ServiceRequest.performer.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.system |
as appropriate |
| ServiceRequest.reasonCode.text |
as received from Requester HCP |
| ServiceRequest.supportingInfo |
as received from Requester HCP |
| ServiceRequest.note.text |
N/A |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
date/time |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
1) "referral-received" 2) "referral-accepted" |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP |
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
Appointment |
| MessageHeader.id |
UUID |
| MessageHader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-add-appointment" |
| MessageHeader.destination.endpoint |
CAT RMS endpoint |
| MessageHeader.author.reference |
Performer HCP UUID |
| MessageHeader.author.type |
"PractitionerRole" |
| MessageHeader.source.endpoint |
Performer HCP endpoint |
| MessageHeader.focus |
Appointment |
| Appointment.id |
UUID |
| Appointment.meta.lastUpdated |
date/time |
| Appointment.identifier.value |
UUID |
| Appointment.identifier.system |
"urn:ietf:rfc:3986" |
| Appointment.status |
"booked" |
| Appointment.start |
as assigned by Performer HCP |
| Appointment.created |
date/time when Performer HCP created appointment |
| Appointment.basedOn.identifier.value |
ServiceRequest provincial identifier |
| Appointment.basedOn.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| Appointment.participant.identifier.value |
1) Patient identifier |
| Appointment.participant.identifier.system |
as appropriate |
| Appointment.participant.reference |
2) Performer HCP UUID |
| Appointment.participant.type |
"PractitionerRole" |
| Appointment.extension.AppointmentClass |
as appropriate |
Step 17: CAT notifies Requester HCP that appointment is booked
See Step 15 above with changes as below:
| Element |
Value |
| MessageHeader.eventCoding |
"notify-update-process-request" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
Step 18: CAT notifies Requester HCP of update to referral record (appointment booked)
See Step 15 above with changes as below:
| Element |
Value |
| MessageHeader.eventCoding |
"notify-update-service-record" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.reason |
"appointment-status-updated" |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP |
| ServiceRequest.priority |
as received from Requester HCP |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP |
| ServiceRequest.code |
as received from Requester HCP |
| ServiceRequest.subject.identifier.value |
Patient identifier |
| ServiceRequest.subject.identifier.system |
as appropriate |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
1) CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.performer.reference |
2) Performer HCP UUID |
| ServiceRequest.performer.type |
"PractitionerRole" |
| ServiceRequest.performer.extension.role |
"receiving-provider" |
| ServiceRequest.reasonCode.text |
as received from Requester HCP |
| ServiceRequest.supportingInfo |
as received from Requester HCP |
| ServiceRequest.note.text |
N/A |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
date/time |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
1) "referral-received" 2) "referral-accepted" 3) "appointment-booked" |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP |
See Step 15 above with changes as below:
| Element |
Value |
| MessageHeader.eventCoding |
"notify-update-process-request" |
| MessageHeader.reason |
"appointment-status-updated" |
| Appointment.status |
"fulfilled" |
Step 22: CAT notifies Requester HCP of appointment completion
See Step 15 above with changes as below:
| Element |
Value |
| MessageHeader.eventCoding |
"notify-update-process-request" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.reason |
"appointment-status-updated" |
| Appointment.status |
"fulfilled" |
Step 23: CAT notifies Requester HCP of update to referral record (appointment attended)
See Step 18 above with changes as below:
| Element |
Value |
| Appointment.status |
"fulfilled" |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
1) "referral-received" 2) "referral-accepted" 3) "appointment-booked" 4) "appointment-attended" |
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
Task |
| MessageHeader.id |
UUID |
| MessageHeader.eventCoding |
"notify-update-process-request" |
| MessageHeader.destination.endpoint |
CAT RMS endpoint |
| MessageHeader.author.reference |
Performer HCP UUID |
| MessageHeader.author.type |
"PractitionerRole" |
| MessageHeader.source.endpoint |
Performer HCP endpoint |
| MessageHeader.focus |
Task |
| Task.id.value |
UUID |
| Task.id.system |
"urn:ietf:rfc:3986" |
| Task.identifier.value |
UUID |
| Task.identifier.system |
"urn:ietf:rfc:3986" |
| Task.basedOn.identifier.value |
ServiceRequest provincial identifier |
| Task.basedOn.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| Task.status |
"completed" |
| Task.businessStatus |
"completed" |
| Task.intent |
"proposal" |
| Task.code |
"process-request" |
| Task.authoredOn |
date/time |
| Task.lastModified |
date/time |
| Task.owner.reference |
Performer HCP UUID |
| Task.owner.type |
"PractitionerRole" |
| Task.output.type |
as appropriate |
| Task.output.value[x].valueString |
1) if with advice in string format OR |
| Task.output.value[x].valueReference |
2) Communication UUID if with advice as a document (e.g. in pdf format) |
| Communication.category |
"advice" - if applicable |
| Communication.recipient.identifier.value |
CAT identifier (HealthcareService) - if applicable |
| Communication.recipient.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" - if applicable |
| Communication.sender.reference |
Performer HCP UUID - if applicable |
| Communication.sender.type |
"PractitionerRole" - if applicable |
Step 27: CAT notifies Requester HCP of service request completed
Same as Step 25 above with changes as below:
| Element |
Value |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| Task.owner.identifier.value |
CAT identifier (HealthcareService) |
| Task.owner.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
Step 28: CAT notifies Requester HCP of update to referral record
Same as Step 7 above with changes as below:
| Element |
Value |
| MessageHeader.reason |
"service-request-status-updated" |
| ServiceRequest.status |
"completed" |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
1) "referral-received" 2) "referral-accepted" 3) "appointment-booked" 4) "appointment-attended" 5) "referral-completed" |
B: Requester HCP sends unsolicited update
The following sequence diagram shows the messaging flow when the Requester HCP sends unsolicited update on service request to the CAT.
See Participants for more information.
Element and Value
Refer to Primary Flow for DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 1: Requester HCP sends unsolicited update to CAT
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-update-service-request" |
| MessageHeader.destination.endpoint |
CAT RMS endpoint |
| MessageHeader.author.reference |
Requester HCP UUID |
| MessageHeader.author.type |
"PractitionerRole" |
| MessageHeader.source.endpoint |
Requester HCP endpoint |
| MessageHeader.reason |
as appropriate |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as previously valued or updated |
| ServiceRequest.priority |
as previously valued or updated |
| ServiceRequest.priority.extension.subPriority |
as previously valued or updated |
| ServiceRequest.code |
as previously valued or updated |
| ServiceRequest.subject.identifier.value |
Patient identifier |
| ServiceRequest.subject.identifier.system |
as appropriate |
| ServiceRequest.authoredOn |
as previously valued |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
1) CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.performer.reference |
2) Performer HCP UUID |
| ServiceRequest.performer.type |
"PractitionerRole" or "HealthcareService" |
| ServiceRequest.performer.extension.role |
"receiving-provider" or "service-location" |
| ServiceRequest.reasonCode.text |
N/A |
| ServiceRequest.supportingInfo |
as previously valued or updated |
| ServiceRequest.note.text |
as previously valued or updated |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
as previously valued |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
as previously valued |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as previously valued or updated |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as previously valued or updated |
| ServiceRequest.extension.patientPreference.extension.rationale |
as previously valued or updated |
Same as Step 1 above with changes as below:
| Element |
Value |
| MessageHeader.destination.endpoint |
Performer HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
E: CAT rejects service request
The following sequence diagram shows the messaging flow when the CAT rejects the service request as invalid or inappropriate.
See Participants for more information.
Element and Value
Refer to Primary Flow for DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 2: CAT notifies Requester HCP that service request is rejected
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
Task |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-update-process-request" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.focus |
Task |
| Task.id |
UUID |
| Task.meta.lastUpdated |
date/time |
| Task.identifier.value |
UUID |
| Task.identifier.system |
"urn:ietf:rfc:3986" |
| Task.basedOn.identifier.value |
ServiceRequest provincial identifier |
| Task.basedOn.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| Task.owner.identifier.value |
CAT identifier (HealthcareService) |
| Task.owner.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| Task.status |
"rejected" |
| Task.businessStatus |
"rejected-by-central-triage" |
| Task.businessStatus.extension.BusinessStatusReason |
as appropriate |
| Task.intent |
"proposal" |
| Task.code |
"process-request" |
| Task.authoredOn |
date/time |
| Task.lastModified |
date/time |
| Task.owner.identifier.value |
CAT identifier (HealthcareService) |
| Task.owner.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| Task.note |
as appropriate |
Step 3: CAT notifies Requester HCP of update to referral record (rejected)
Same as Step 2 above with changes as below:
| Element |
Value |
| MessageHeader.reason |
"service-request-status-updated" |
| MessageHeader.eventCoding |
"notify-update-service-record" |
| Task.basedOn.reference |
UUID |
| Task.basedOn.type |
"ServiceRequest" |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.status |
"revoked" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP |
| ServiceRequest.priority |
as received from Requester HCP |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP |
| ServiceRequest.code |
as received from Requester HCP |
| ServiceRequest.subject.identifier |
Patient identifier |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.reasonCode.text |
as received from Requester HCP |
| ServiceRequest.supportingInfo |
as received from Requester HCP |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
as previously valued |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
as previously valued + "referral-rejected" |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.rationale |
as received from Requester HCP |
H: Requester HCP revokes service request
The following sequence diagram shows the messaging flow when the Requester HCP (Referring Provider) revokes the service request.
See Participants for more information.
Element and Value
Refer to Primary Flow for DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 1: Requester HCP revokes service request
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"revoke-service-request" |
| MessageHeader.destination.endpoint |
CAT RMS endpoint |
| MessageHeader.author.reference |
Requester HCP UUID |
| MessageHeader.author.type |
"PractitionerRole" |
| MessageHeader.source.endpoint |
Requester HCP endpoint |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"revoked" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as previously valued |
| ServiceRequest.priority |
as previously valued |
| ServiceRequest.priority.extension.subPriority |
as previously valued |
| ServiceRequest.code |
as previously valued |
| ServiceRequest.subject.identifier |
Patient identifier |
| ServiceRequest.authoredOn |
as previously valued |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
1) CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.performer.reference |
2) Performer HCP UUID (if previously assigned by CAT) |
| ServiceRequest.performer.type |
"PractitionerRole" or "HealthcareService" |
| ServiceRequest.performer.extension.role |
"receiving-provider" or "service-location" |
| ServiceRequest.reasonCode.text |
as previously valued |
| ServiceRequest.supportingInfo |
as previously valued |
| ServiceRequest.note.text |
as appropriate |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
as previously valued |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
as previously valued |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as previously valued |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as previously valued |
| ServiceRequest.extension.patientPreference.extension.rationale |
as previously valued |
| ServiceRequest.extension.RequestStatusReason |
appropriate revocation reason |
Step 2.1: CAT notifies Requester HCP that service request was cancelled
See Step 10 in Primary Flow message flow with changes as below:
| Element |
Value |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| Task.status |
"cancelled" |
| Task.businessStatus |
"cancelled-by-requester" |
| Task.owner.identifier.value |
CAT identifier (HealthcareService) |
| Task.owner.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
Same as Step 1 above with changes as below:
| Element |
Value |
| MessageHeader.eventCoding |
"notify-update-service-request" |
| MessageHeader.destination.endpoint |
Performer HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.reason |
"service-request-status-updated" |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
as previously valued + "referral-cancelled" |
I: CAT cancels service request
The following sequence diagram shows the messaging flow when the CAT cancels the service request.
Note: The CAT only cancels the service request if it hasn't been sent to Performer HCP.
See Participants for more information.
Element and Value
Refer to Primary Flow for DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 2: CAT notifies Requester HCP of service request cancellation
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
Task |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-update-process-request" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.focus |
Task |
| Task.id |
UUID |
| Task.meta.lastUpdated |
date/time |
| Task.identifier.value |
UUID |
| Task.identifier.system |
"urn:ietf:rfc:3986" |
| Task.basedOn.identifier.value |
ServiceRequest provincial identifier |
| Task.basedOn.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| Task.status |
"cancelled" |
| Task.businessStatus |
"cancelled-by-triage" |
| Task.businessStatus.extension.BusinessStatusReason |
as appropriate |
| Task.intent |
"proposal" |
| Task.code |
"process-request" |
| Task.authoredOn |
date/time |
| Task.lastModified |
date/time |
| Task.owner.identifier.value |
CAT identifier (HealthcareService) |
| Task.owner.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| Task.note |
as appropriate |
Step 3: CAT notifies Requester HCP of update to referral record (cancelled)
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-update-service-record" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.reason |
"service-request-status-updated" |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"revoked" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP |
| ServiceRequest.priority |
as received from Requester HCP |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP |
| ServiceRequest.code |
as received from Requester HCP |
| ServiceRequest.subject.identifier |
Patient identifier |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Requester HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.reasonCode.text |
as received from Requester HCP |
| ServiceRequest.supportingInfo |
as received from Requester HCP |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
as previously valued |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
as previously valued + "referral-cancelled" |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP |
| ServiceRequest.extension.patientPreference.extension.rationale |
as received from Requester HCP |
O: CAT creates service request on behalf of Requester HCP
The message flow starting from Step 3 in Primary Flow shows the messaging flow when the CAT creates a follow-on service request (based on a preceding service request) on behalf of Requester HCP.
Element and Value
Refer to Primary Flow for DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 4: CAT notifies Requester HCP of creation of referral record
| Element |
Value |
| MessageHeader.reason |
TBD |
| ServiceRequest.basedOn.identifier.value |
provincial identifier assigned by CAT |
| ServiceRequest.basedOn.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
P: CAT assigns service request to another CAT
The following sequence diagram shows the messaging flow when the CAT assigns the service request to another CAT.
See Participants for more information.
Element and Value
Refer to Primary Flow for DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 2: CAT notifies Requester HCP of updated to referral record
See Step 7 in Primary Flow message flow with changes as below:
| Element |
Value |
| ServiceRequest.performer.identifier.value |
CAT identifier (HealthcareService) (Note: This is the newly assigned CAT and replaces the CAT initially assigned by Requester HCP) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.type |
"HealthcareService" |
| ServiceRequest.performer.extension.role |
"central-intake" |
R: CAT completes service request with advice
The following sequence diagram shows the messaging flow when CAT completes the service request with advice.
Note: This workflow takes place during clerical triage in the CAT.
See Participants for more information.
Element and Value
Refer to Primary Flow for Communication,DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 2: CAT notifies Requester HCP of service completion and advice
Same as Step 27 in Primary Flow message flow with changes as below:
| Element |
Value |
| Task.businessStatus |
"completed-with-advice" |
| Task.output.type |
"advice" |
| Communication.inResponseTo |
N/A |
| Communication.category |
"advice" |
| Communication.recipient.reference |
Requester HCP UUID |
| Communication.recipient.type |
"PractitionerRole" |
| Communication.sender.identifier.value |
CAT identifier (HealthcareService) |
| Communication.sender.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
Step 3: CAT notifies Requester HCP of update to referral record
See Step 28 in Primary Flow message flow with changes as below:
| Element |
Value |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
as previously valued + "referral-completed-with-advice" |
S: CAT sends unsolicited update
The following sequence diagram shows the messaging flow when CAT sends unsolicited update to the service request.
See Participants for more information.
Element and Value
Refer to Primary Flow for DocumentReference, HealthcareService, Location, Patient, Practitioner, and PractitionerRole elements.
Step 2: CAT notifies Requester HCP of update to service request
See Step 12 in Primary Flow message flow with changes as below:
| Element |
Value |
| Task.note |
as appropriate |
| MessageHeader.reason |
"service-request-updated-other" |
Step 3: CAT notifies Requester HCP of update to referral record
| Element |
Value |
| Bundle.meta.extension.submissionMetadata |
Metadata for: Submitting Site; EMR Vendor Name; EMR Product Name; Submission Implementation Guide (IG) Type; Submission Implementation Guide (IG) Version; Service Delivery Site; Authoring Provider ID |
| Bundle.id |
UUID |
| Bundle.meta.lastUpdated |
date/time |
| Bundle.meta.security |
"R" |
| Bundle.identifier.value |
UUID |
| Bundle.identifier.system |
"urn:ietf:rfc:3986" |
| Bundle.type |
"message" |
| Bundle.timestamp |
current date/time |
| Bundle.entry:MessageHeader |
MessageHeader |
| Bundle.entry:Focus |
ServiceRequest |
| MessageHeader.id |
UUID |
| MessageHeader.meta.lastUpdated |
date/time |
| MessageHeader.eventCoding |
"notify-update-service-record" |
| MessageHeader.destination.endpoint |
Requester HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| MessageHeader.reason |
"service-request-updated-other" |
| MessageHeader.focus |
ServiceRequest |
| ServiceRequest.id |
UUID |
| ServiceRequest.meta.lastUpdated |
date/time |
| ServiceRequest.identifier.value |
provincial identifier |
| ServiceRequest.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-id" |
| ServiceRequest.identifier.use |
"official" |
| ServiceRequest.status |
"active" |
| ServiceRequest.intent |
"proposal" |
| ServiceRequest.category |
as received from Requester HCP or as updated by CAT |
| ServiceRequest.priority |
as received from Requester HCP or as updated by CAT |
| ServiceRequest.priority.extension.subPriority |
as received from Requester HCP or as updated by CAT |
| ServiceRequest.code |
as received from Requester HCP or as assigned by CAT or as updated by CAT |
| ServiceRequest.subject.identifier.value |
Patient identifier |
| ServiceRequest.subject.identifier.system |
as appropriate |
| ServiceRequest.authoredOn |
as received from Requester HCP |
| ServiceRequest.requester.reference |
Request HCP UUID |
| ServiceRequest.requester.type |
"PractitionerRole" |
| ServiceRequest.performer.identifier.value |
1) CAT identifier (HealthcareService) |
| ServiceRequest.performer.identifier.system |
"https://fhir.alberta.ca/NamingSystem/ca-ab-eref-healthcare-service-id" |
| ServiceRequest.performer.extension.role |
"central-intake" |
| ServiceRequest.performer.reference |
2) Performer HCP UUID |
| ServiceRequest.performer.type |
"PractitionerRole" or "HealthcareService" |
| ServiceRequest.performer.extension.role |
"receiving-provider" or "service-location" |
| ServiceRequest.reasonCode.text |
as received from Requester HCP or as updated by CAT |
| ServiceRequest.supportingInfo |
as received from Requester HCP or as updated by CAT |
| ServiceRequest.note.text |
N/A |
| ServiceRequest.extension.referralTimestamp.extension.timestamp |
date/time |
| ServiceRequest.extension.referralTimestamp.extension.timestampType |
as previously assigned |
| ServiceRequest.extension.patientPreference.extension.preferenceType |
"preferred" |
| ServiceRequest.extension.patientPreference.extension.preferenceValueType |
as received from Requester HCP or as updated by CAT |
| ServiceRequest.extension.patientPreference.extension.preferenceValue |
as received from Requester HCP or as updated by CAT |
Same as Step 3 above with changes as below:
| Element |
Value |
| MessageHeader.destination.endpoint |
Performer HCP EMR endpoint |
| MessageHeader.source.endpoint |
CAT RMS endpoint |
| ServiceRequest.performer.reference |
Performer HCP UUID |
| ServiceRequest.performer.type |
"PractitionerRole" or "HealthcareService" |
