Profiles & Operations > Structure Definition: Appointment Profile

Profile: Appointment

Canonical URL:https://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-Appointment

Simplifier project page: appointment

Derived from: Appointment

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
serviceCategoryΣ0..*CodeableConcept
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
appointmentTypeΣ0..1CodeableConceptBinding
reasonCodeΣ0..*CodeableConceptBinding
reasonReferenceI0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)
priority0..1unsignedInt
description0..1string
supportingInformationI0..*Reference(Resource)
startS Σ0..1instant
endS Σ0..1instant
minutesDuration0..1positiveInt
slotI0..*Reference(Slot)
created0..1dateTime
comment0..1string
patientInstruction0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
actorS Σ I1..1Reference(MHA Patient Profile)
requiredΣ0..1codeBinding
statusS Σ1..1codeBinding
periodI0..1Period
requestedPeriodI0..*Period

Hybrid View

SearchParameter

Snapshot View

SearchParameter

Table View

SearchParameter.id[0]AppointmentResponse-appointment
SearchParameter.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
SearchParameter.extension[0].value[0]trial-use
SearchParameter.url[0]http://hl7.org/fhir/SearchParameter/AppointmentResponse-appointment
SearchParameter.version[0]4.0.1
SearchParameter.name[0]appointment
SearchParameter.status[0]draft
SearchParameter.experimental[0]False
SearchParameter.date[0]2019-11-01T09:29:23+11:00
SearchParameter.publisher[0]Health Level Seven International (Patient Administration)
SearchParameter.contact[0].telecom[0].system[0]url
SearchParameter.contact[0].telecom[0].value[0]http://hl7.org/fhir
SearchParameter.contact[1].telecom[0].system[0]url
SearchParameter.contact[1].telecom[0].value[0]http://www.hl7.org/Special/committees/pafm/index.cfm
SearchParameter.description[0]The appointment that the response is attached to
SearchParameter.code[0]appointment
SearchParameter.base[0]AppointmentResponse
SearchParameter.type[0]reference
SearchParameter.expression[0]AppointmentResponse.appointment
SearchParameter.xpath[0]f:AppointmentResponse/f:appointment
SearchParameter.xpathUsage[0]normal
SearchParameter.target[0]Appointment

JSON View

{
    "resourceType": "SearchParameter",
    "id": "AppointmentResponse-appointment",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        }
    ],
    "url": "http://hl7.org/fhir/SearchParameter/AppointmentResponse-appointment",
    "version": "4.0.1",
    "name": "appointment",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "Health Level Seven International (Patient Administration)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        },
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
                }
            ]
        }
    ],
    "description": "The appointment that the response is attached to",
    "code": "appointment",
    "base":  [
        "AppointmentResponse"
    ],
    "type": "reference",
    "expression": "AppointmentResponse.appointment",
    "xpath": "f:AppointmentResponse/f:appointment",
    "xpathUsage": "normal",
    "target":  [
        "Appointment"
    ]
}

Usage

The Appointment Resource is used capture information related to a booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). The Appointment Resource should be included in a bundle submission when the client's first appointment has been rescheduled.

Notes

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: https://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-Appointment
.meta.versionId

  • SHALL be populated by the OH FHIR server
  • source systems do not need to populate this element prior to submission
.status

  • SHALL contain a code representing overall status of the Appointment.
  • SHALL contain a code of noshow in this field when the client did not show for their first appointment NOTE: due to an issue in FHIR R4, please do not use "noshow". Always use "cancelled"..
  • SHALL contain a code of cancelled in this field when the client's first appointment is cancelled due to a system delay or the client rescheduled.
.cancelationReason

  • SHOULD contain a code representing the reason for reschedule of the client's first scheduled appointment
  • .status SHALL be populated with cancelled in order to use .cancelationReason
  • SHALL contain a code of System Delay when the appointment was canceled or rescheduled due to a system delay.
  • SHALL contain a code of Client Rescheduled when the appointment was rescheduled by the client.
  • SHALL contain a code of Client Did Not Show when the appointment was rescheduled due to a client not showing up for an appointment.
.start

  • SHALL contain the date of the first appointment that was offered and accepted by the client regardless of whether they attended the appointment or subsequently changed it.
.participant

  • SHALL contain a reference to the Patient resource to which the Appointment resource applies.