Profiles & Operations > Profile: Appointment

Profile: Appointment

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Appointment

Simplifier project page: Appointment

Derived from: Appointment (R4)

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..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
cancellationDateS I0..1Extension(dateTime)
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBooleanboolean
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
url1..1uriFixed Value
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
appointmentTypeΣ0..1CodeableConceptBinding
reasonCodeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
priority0..1unsignedInt
description0..1string
supportingInformationI0..1Reference(Resource)
startS Σ0..1instant
endS Σ0..1instant
minutesDurationS0..1positiveInt
slotI0..*Reference(Slot)
createdS0..1dateTime
commentS0..1string
patientInstruction0..1string
basedOnI0..*Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..1uriBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
requestedPeriodI0..*Period

Hybrid View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
cancellationDateS I0..1Extension(dateTime)
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBooleanboolean
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
url1..1uriFixed Value
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
appointmentTypeΣ0..1CodeableConceptBinding
reasonCodeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
priority0..1unsignedInt
description0..1string
supportingInformationI0..1Reference(Resource)
startS Σ0..1instant
endS Σ0..1instant
minutesDurationS0..1positiveInt
slotI0..*Reference(Slot)
createdS0..1dateTime
commentS0..1string
patientInstruction0..1string
basedOnI0..*Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..1uriBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
requestedPeriodI0..*Period

Snapshot View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
cancellationDateS I0..1Extension(dateTime)
id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueBooleanboolean
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
url1..1uriFixed Value
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionΣ0..1string
codeS Σ0..1codeBinding
displayS Σ0..1string
userSelectedΣ0..1boolean
textS Σ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1codeBinding
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
serviceTypeΣ0..*CodeableConcept
specialtyΣ0..*CodeableConceptBinding
appointmentTypeΣ0..1CodeableConceptBinding
reasonCodeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
priority0..1unsignedInt
description0..1string
supportingInformationI0..1Reference(Resource)
startS Σ0..1instant
endS Σ0..1instant
minutesDurationS0..1positiveInt
slotI0..*Reference(Slot)
createdS0..1dateTime
commentS0..1string
patientInstruction0..1string
basedOnI0..*Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..1uriBinding
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodI0..1Period
requestedPeriodI0..*Period

Table View

Appointment..
Appointment.meta1..
Appointment.meta.profile1..
Appointment.extensionExtension..
Appointment.extensionExtension..
Appointment.extension.extension..
Appointment.extension.extension..
Appointment.identifier1..1
Appointment.identifier.system1..
Appointment.identifier.value1..
Appointment.status..
Appointment.cancelationReason..
Appointment.cancelationReason.coding..1
Appointment.cancelationReason.coding.system..
Appointment.cancelationReason.coding.code..
Appointment.cancelationReason.coding.display..
Appointment.cancelationReason.text..
Appointment.serviceCategory..
Appointment.serviceCategory.coding..
Appointment.serviceCategory.coding.code..
Appointment.appointmentType..
Appointment.reasonReferenceReference(Procedure)1..1
Appointment.reasonReference.reference1..
Appointment.supportingInformation..1
Appointment.start..
Appointment.end..
Appointment.minutesDuration..
Appointment.created..
Appointment.comment..
Appointment.participant..2
Appointment.participant.actorReference(Patient)1..
Appointment.participant.actor.reference..
Appointment.participant.actor.identifier..
Appointment.participant.actor.identifier.system1..
Appointment.participant.actor.identifier.value1..

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-seris-profile-Appointment",
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Appointment",
    "version": "1.0.0",
    "name": "Appointment",
    "title": "Appointment",
    "status": "draft",
    "date": "2023-03-06",
    "publisher": "Ontario Health",
    "contact":  [
        {
            "name": "Ontario Health",
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://ontariohealth.ca/fhir/"
                },
                {
                    "system": "email",
                    "value": "some.email@ontariohealth.ca"
                }
            ]
        }
    ],
    "description": "A booking of a surgical healthcare procedure for a specific date/time.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "SERIS-MDS-Mapping",
            "name": "SERIS MDS Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Appointment",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Appointment.meta",
                "path": "Appointment.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.meta.profile",
                "path": "Appointment.meta.profile",
                "comment": "#### **_` FOR SERIS USAGE: The meta.profile = http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Appointment|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.extension:cancellationDate",
                "path": "Appointment.extension",
                "sliceName": "cancellationDate",
                "short": "Cancellation Date",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-ext-cancellation-date"
                        ]
                    }
                ],
                "isModifier": false,
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Cancellation Date"
                    }
                ]
            },
            {
                "id": "Appointment.extension:reschedule",
                "path": "Appointment.extension",
                "sliceName": "reschedule",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-ext-reschedule"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Appointment.extension:reschedule.extension:rescheduleFlag",
                "path": "Appointment.extension.extension",
                "sliceName": "rescheduleFlag",
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Reschedule Flag"
                    }
                ]
            },
            {
                "id": "Appointment.extension:reschedule.extension:rescheduleDate",
                "path": "Appointment.extension.extension",
                "sliceName": "rescheduleDate",
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Reschedule Date"
                    }
                ]
            },
            {
                "id": "Appointment.identifier",
                "path": "Appointment.identifier",
                "short": "Case Number",
                "min": 1,
                "max": "1",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Case Number"
                    }
                ]
            },
            {
                "id": "Appointment.identifier.system",
                "path": "Appointment.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.identifier.value",
                "path": "Appointment.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.status",
                "path": "Appointment.status",
                "mustSupport": true
            },
            {
                "id": "Appointment.cancelationReason",
                "path": "Appointment.cancelationReason",
                "short": "Cancellation reason",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/surgery-cancellation-reason"
                },
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Cancellation Reason"
                    }
                ]
            },
            {
                "id": "Appointment.cancelationReason.coding",
                "path": "Appointment.cancelationReason.coding",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/surgery-cancellation-reason"
                }
            },
            {
                "id": "Appointment.cancelationReason.coding.system",
                "path": "Appointment.cancelationReason.coding.system",
                "fixedUri": "http://ontariohealth.ca/fhir/CodeSystem/surgery-cancellation-reason",
                "mustSupport": true
            },
            {
                "id": "Appointment.cancelationReason.coding.code",
                "path": "Appointment.cancelationReason.coding.code",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/surgery-cancellation-reason"
                }
            },
            {
                "id": "Appointment.cancelationReason.coding.display",
                "path": "Appointment.cancelationReason.coding.display",
                "mustSupport": true
            },
            {
                "id": "Appointment.cancelationReason.text",
                "path": "Appointment.cancelationReason.text",
                "short": "Cancellation reason description",
                "mustSupport": true
            },
            {
                "id": "Appointment.serviceCategory",
                "path": "Appointment.serviceCategory",
                "short": "Surgeon service",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/hospital-service"
                }
            },
            {
                "id": "Appointment.serviceCategory.coding",
                "path": "Appointment.serviceCategory.coding",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/hospital-service"
                }
            },
            {
                "id": "Appointment.serviceCategory.coding.code",
                "path": "Appointment.serviceCategory.coding.code",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://ontariohealth.ca/fhir/ValueSet/hospital-service"
                }
            },
            {
                "id": "Appointment.appointmentType",
                "path": "Appointment.appointmentType",
                "short": "Patient type"
            },
            {
                "id": "Appointment.reasonReference",
                "path": "Appointment.reasonReference",
                "short": "The surgical procedure for this appointment",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Procedure"
                        ],
                        "aggregation":  [
                            "bundled"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Appointment.reasonReference.reference",
                "path": "Appointment.reasonReference.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.supportingInformation",
                "path": "Appointment.supportingInformation",
                "short": "supporting Observations",
                "max": "1"
            },
            {
                "id": "Appointment.start",
                "path": "Appointment.start",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Scheduled Start Time"
                    }
                ]
            },
            {
                "id": "Appointment.end",
                "path": "Appointment.end",
                "mustSupport": true
            },
            {
                "id": "Appointment.minutesDuration",
                "path": "Appointment.minutesDuration",
                "short": "Estimated Case Duration",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Estimated Case Duration"
                    }
                ]
            },
            {
                "id": "Appointment.created",
                "path": "Appointment.created",
                "short": "Booking Date",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Booking Date"
                    }
                ]
            },
            {
                "id": "Appointment.comment",
                "path": "Appointment.comment",
                "short": "Notes on initial case scheduling",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "SERIS-MDS-Mapping",
                        "map": "Notes"
                    }
                ]
            },
            {
                "id": "Appointment.participant",
                "path": "Appointment.participant",
                "max": "2",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor",
                "path": "Appointment.participant.actor",
                "short": "the surgical patient or OR Room",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.reference",
                "path": "Appointment.participant.actor.reference",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.identifier",
                "path": "Appointment.participant.actor.identifier",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.identifier.system",
                "path": "Appointment.participant.actor.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.identifier.value",
                "path": "Appointment.participant.actor.identifier.value",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="ca-on-seris-profile-Appointment" />
    <url value="http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Appointment" />
    <version value="1.0.0" />
    <name value="Appointment" />
    <title value="Appointment" />
    <status value="draft" />
    <date value="2023-03-06" />
    <publisher value="Ontario Health" />
    <contact>
        <name value="Ontario Health" />
        <telecom>
            <system value="url" />
            <value value="http://ontariohealth.ca/fhir/" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="some.email@ontariohealth.ca" />
        </telecom>
    </contact>
    <description value="A booking of a surgical healthcare procedure for a specific date/time." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="SERIS-MDS-Mapping" />
        <name value="SERIS MDS Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Appointment" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Appointment" />
    <derivation value="constraint" />
    <differential>
        <element id="Appointment.meta">
            <path value="Appointment.meta" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.meta.profile">
            <path value="Appointment.meta.profile" />
            <comment value="#### **_` FOR SERIS USAGE: The meta.profile = http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Appointment|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set." />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.extension:cancellationDate">
            <path value="Appointment.extension" />
            <sliceName value="cancellationDate" />
            <short value="Cancellation Date" />
            <type>
                <code value="Extension" />
                <profile value="http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-ext-cancellation-date" />
            </type>
            <isModifier value="false" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Cancellation Date" />
            </mapping>
        </element>
        <element id="Appointment.extension:reschedule">
            <path value="Appointment.extension" />
            <sliceName value="reschedule" />
            <type>
                <code value="Extension" />
                <profile value="http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-ext-reschedule" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="Appointment.extension:reschedule.extension:rescheduleFlag">
            <path value="Appointment.extension.extension" />
            <sliceName value="rescheduleFlag" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Reschedule Flag" />
            </mapping>
        </element>
        <element id="Appointment.extension:reschedule.extension:rescheduleDate">
            <path value="Appointment.extension.extension" />
            <sliceName value="rescheduleDate" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Reschedule Date" />
            </mapping>
        </element>
        <element id="Appointment.identifier">
            <path value="Appointment.identifier" />
            <short value="Case Number" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Case Number" />
            </mapping>
        </element>
        <element id="Appointment.identifier.system">
            <path value="Appointment.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.identifier.value">
            <path value="Appointment.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.status">
            <path value="Appointment.status" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.cancelationReason">
            <path value="Appointment.cancelationReason" />
            <short value="Cancellation reason" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ontariohealth.ca/fhir/ValueSet/surgery-cancellation-reason" />
            </binding>
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Cancellation Reason" />
            </mapping>
        </element>
        <element id="Appointment.cancelationReason.coding">
            <path value="Appointment.cancelationReason.coding" />
            <max value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ontariohealth.ca/fhir/ValueSet/surgery-cancellation-reason" />
            </binding>
        </element>
        <element id="Appointment.cancelationReason.coding.system">
            <path value="Appointment.cancelationReason.coding.system" />
            <fixedUri value="http://ontariohealth.ca/fhir/CodeSystem/surgery-cancellation-reason" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.cancelationReason.coding.code">
            <path value="Appointment.cancelationReason.coding.code" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ontariohealth.ca/fhir/ValueSet/surgery-cancellation-reason" />
            </binding>
        </element>
        <element id="Appointment.cancelationReason.coding.display">
            <path value="Appointment.cancelationReason.coding.display" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.cancelationReason.text">
            <path value="Appointment.cancelationReason.text" />
            <short value="Cancellation reason description" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.serviceCategory">
            <path value="Appointment.serviceCategory" />
            <short value="Surgeon service" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ontariohealth.ca/fhir/ValueSet/hospital-service" />
            </binding>
        </element>
        <element id="Appointment.serviceCategory.coding">
            <path value="Appointment.serviceCategory.coding" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ontariohealth.ca/fhir/ValueSet/hospital-service" />
            </binding>
        </element>
        <element id="Appointment.serviceCategory.coding.code">
            <path value="Appointment.serviceCategory.coding.code" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://ontariohealth.ca/fhir/ValueSet/hospital-service" />
            </binding>
        </element>
        <element id="Appointment.appointmentType">
            <path value="Appointment.appointmentType" />
            <short value="Patient type" />
        </element>
        <element id="Appointment.reasonReference">
            <path value="Appointment.reasonReference" />
            <short value="The surgical procedure for this appointment" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Procedure" />
                <aggregation value="bundled" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Appointment.reasonReference.reference">
            <path value="Appointment.reasonReference.reference" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.supportingInformation">
            <path value="Appointment.supportingInformation" />
            <short value="supporting Observations" />
            <max value="1" />
        </element>
        <element id="Appointment.start">
            <path value="Appointment.start" />
            <mustSupport value="true" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Scheduled Start Time" />
            </mapping>
        </element>
        <element id="Appointment.end">
            <path value="Appointment.end" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.minutesDuration">
            <path value="Appointment.minutesDuration" />
            <short value="Estimated Case Duration" />
            <mustSupport value="true" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Estimated Case Duration" />
            </mapping>
        </element>
        <element id="Appointment.created">
            <path value="Appointment.created" />
            <short value="Booking Date" />
            <mustSupport value="true" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Booking Date" />
            </mapping>
        </element>
        <element id="Appointment.comment">
            <path value="Appointment.comment" />
            <short value="Notes on initial case scheduling" />
            <mustSupport value="true" />
            <mapping>
                <identity value="SERIS-MDS-Mapping" />
                <map value="Notes" />
            </mapping>
        </element>
        <element id="Appointment.participant">
            <path value="Appointment.participant" />
            <max value="2" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor">
            <path value="Appointment.participant.actor" />
            <short value="the surgical patient or OR Room" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Patient" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.reference">
            <path value="Appointment.participant.actor.reference" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.identifier">
            <path value="Appointment.participant.actor.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.identifier.system">
            <path value="Appointment.participant.actor.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.identifier.value">
            <path value="Appointment.participant.actor.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

Usage

Appointment resource will be used to capture the Case Scheduled details based on a planned meeting (booking). The Appointment is associated with a Patient, Procedure, and OR room. The Location (OR Room) shall be referenced using the identifier (same identifier used during creation of the OR). If a Case is cancelled in Advance or on the Same Day, then a cancellation reason and cancellation date shall be provided in the Appointment resource.

Notes

.id

  • used to uniquely identify the resource

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-seris-profile-Appointment

.meta.lastUpdated

  • SHALL be populated by the sending application
  • contains value for Creation or Last Updated Date

.extension:reschedule

  • rescheduleFlag - indicate whether an appointment has been rescheduled or not.
  • rescheduleDate - indicates the date when the Appointment will take place/rescheduled

.extension:cancellationDate

  • date and time when the appointment was cancelled

.identifier

  • Case Number: Facility specific unique record identifier

.status

  • Appointment state proposed/fulfilled/cancelled

.cancellationReason

  • Facility Cancellation Reason Code/Facility Cancellation Reason Description Facility-specific value representing the reason surgery was cancelled. Description is placed in the text attribute

.serviceCategory

  • Surgeon Service Facility-specific value representing the service code associated with this case’s surgeon. The Surgeon Service is the preferred value to be entered here.

.reasonReference

  • A reference to the Surgical Procedure details for this surgery booking

.start

  • indicates the time when the appointment starts

.end

  • indicates the time when the appointment ends. If end time is not known, put same as .start time.

.minutesDuration

  • Estimated Case Duration in minutes.

.created

  • Booking date

.comment

  • Notes end user to place any additional notes regarding the record

.participant

  • participant.actor.reference - Patient reference
  • participant.actor.identifier - using the system- value pair to capture Location OR room