This page is part of the Argonaut Scheduling Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions 
XML Format: StructureDefinition-argo-appt
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="argo-appt"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment" title="null">Appointment</a><a name="Appointment"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.id" title="null">id</a><a name="Appointment.id"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#id">id</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck14.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_extension_simple.png" alt="." style="background-color: white; background-color: inherit" title="Simple Extension" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.extension:status-reason-extension" title="Extension URL = http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-status-reason">extension-status-reason</a><a name="Appointment.extension"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span>..<span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Reason For Current Status<br/><span style="font-weight:bold">URL: </span><a href="http://hl7.org/fhir/STU3/StructureDefinition-extension-status-reason.html">http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-status-reason</a><br/><span style="font-weight:bold">Binding: </span><a href="ValueSet-status-reason.html">Argonaut_Appointment_Event_Reason_Codes</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#preferred" title="Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.">preferred</a>)</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.status" title="null">status</a><a name="Appointment.status"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.serviceType" title="null">serviceType</a><a name="Appointment.serviceType"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="ValueSet-visit-type.html">Argonaut_Visit_Types</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)<br/></td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.specialty" title="null">specialty</a><a name="Appointment.specialty"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="ValueSet-specialty.html">Argonaut_Scheduling_Specialties</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)<br/></td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.appointmentType" title="null">appointmentType</a><a name="Appointment.appointmentType"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="ValueSet-appt-type.html">Argonaut_Appointment_Types</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.start" title="null">start</a><a name="Appointment.start"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#instant">instant</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.end" title="null">end</a><a name="Appointment.end"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#instant">instant</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck15.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.participant:p-1" title="Slice p-1: null">participant</a><a name="Appointment.participant"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#BackboneElement">BackboneElement</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck150.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_slice.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.participant:p-1.actor" title="null">actor</a><a name="Appointment.participant.actor"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="http://hl7.org/fhir/us/core/1.0.1//StructureDefinition-us-core-location.html">US Core Location Profile</a> | <a href="http://hl7.org/fhir/us/core/1.0.1//StructureDefinition-us-core-patient.html">US Core Patient Profile</a> | <a href="http://hl7.org/fhir/us/core/1.0.1//StructureDefinition-us-core-practitioner.html">US Core Practitioner Profile</a> | <a href="http://hl7.org/fhir/STU3/healthcareservice.html">HealthcareService</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck140.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end_slice.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.participant:p-1.status" title="null">status</a><a name="Appointment.participant.status"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-argo-appt-definitions.html#Appointment.requestedPeriod" title="null">requestedPeriod</a><a name="Appointment.requestedPeriod"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#Period">Period</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-appt"/> <version value="1.0.0"/> <name value="Argonaut_Appointment_Profile"/> <title value="Argonaut Appointment Profile"/> <status value="active"/> <date value="2017-06-13T00:00:00+10:00"/> <publisher value="Argonaut Project"/> <contact> <telecom> <system value="url"/> <value value="http://argonautwiki.hl7.org"/> </telecom> </contact> <description value="The Argonaut Appointment Profile is used with the '$find', '$hold', and '$book' operations and when fetching appointments."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States of America"/> </coding> </jurisdiction> <fhirVersion value="3.0.1"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="ical"/> <uri value="http://www.ietf.org/rfc/rfc2445.txt"/> <name value="iCalendar"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Appointment"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Appointment"/> <derivation value="constraint"/> <snapshot> <element id="Appointment"> <path value="Appointment"/> <short value="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)"/> <definition value="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)."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="app-3"/> <severity value="error"/> <human value="Only proposed or cancelled appointments can be missing start/end dates"/> <expression value="(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))"/> <xpath value="((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled'))"/> <source value="Appointment"/> </constraint> <constraint> <key value="app-2"/> <severity value="error"/> <human value="Either start and end are specified, or neither"/> <expression value="start.empty() xor end.exists()"/> <xpath value="((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))"/> <source value="Appointment"/> </constraint> <mustSupport value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="rim"/> <map value="Act[@moodCode <= 'INT']"/> </mapping> <mapping> <identity value="ical"/> <map value="VEVENT"/> </mapping> <mapping> <identity value="w5"/> <map value="workflow.scheduling"/> </mapping> </element> <element id="Appointment.id"> <path value="Appointment.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mustSupport value="true"/> <isSummary value="true"/> </element> <element id="Appointment.meta"> <path value="Appointment.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="Appointment.implicitRules"> <path value="Appointment.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="Appointment.language"> <path value="Appointment.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="Appointment.text"> <path value="Appointment.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Appointment.contained"> <path value="Appointment.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Appointment.extension"> <path value="Appointment.extension"/> <slicing id="1"> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element id="Appointment.extension:status-reason-extension"> <path value="Appointment.extension"/> <sliceName value="status-reason-extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-status-reason"/> </type> <condition value="ele-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="ext-1"/> <severity value="error"/> <human value="Must have either extensions or value[x], not both"/> <expression value="extension.exists() != value.exists()"/> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> <source value="Extension"/> </constraint> <mustSupport value="true"/> </element> <element id="Appointment.modifierExtension"> <path value="Appointment.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Appointment.identifier"> <path value="Appointment.identifier"/> <short value="External Ids for this item"/> <definition value="This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="SCH-1, SCH-2, ARQ-1, ARQ-2"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="ical"/> <map value="UID"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="Appointment.status"> <path value="Appointment.status"/> <short value="proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error"/> <definition value="The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status."/> <comment value="If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid."/> <min value="1"/> <max value="1"/> <base> <path value="Appointment.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AppointmentStatus"/> </extension> <strength value="required"/> <description value="The free/busy status of an appointment."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/appointmentstatus"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="SCH-25"/> </mapping> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element id="Appointment.serviceCategory"> <path value="Appointment.serviceCategory"/> <short value="A broad categorisation of the service that is to be performed during this appointment"/> <definition value="A broad categorisation of the service that is to be performed during this appointment."/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.serviceCategory"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="service-category"/> </extension> <strength value="example"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/service-category"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="n/a, might be inferred from the ServiceDeliveryLocation"/> </mapping> </element> <element id="Appointment.serviceType"> <path value="Appointment.serviceType"/> <short value="The specific service that is to be performed during this appointment"/> <definition value="The specific service that is to be performed during this appointment."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.serviceType"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://fhir.org/guides/argonaut-scheduling/ValueSet/visit-type"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="n/a, might be inferred from the ServiceDeliveryLocation"/> </mapping> </element> <element id="Appointment.specialty"> <path value="Appointment.specialty"/> <short value="The specialty of a practitioner that would be required to perform the service requested in this appointment"/> <definition value="The specialty of a practitioner that would be required to perform the service requested in this appointment."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.specialty"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://fhir.org/guides/argonaut-scheduling/ValueSet/specialty"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".performer.AssignedPerson.code"/> </mapping> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="Appointment.appointmentType"> <path value="Appointment.appointmentType"/> <short value="The style of appointment or patient that has been booked in the slot (not service type)"/> <definition value="The style of appointment or patient that has been booked in the slot (not service type)."/> <alias value="`"/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.appointmentType"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://fhir.org/guides/argonaut-scheduling/ValueSet/appt-type"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="ARQ-7"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element id="Appointment.reason"> <path value="Appointment.reason"/> <short value="Reason this appointment is scheduled"/> <definition value="The reason that this appointment is being scheduled. This is more clinical than administrative."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.reason"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ApptReason"/> </extension> <strength value="preferred"/> <description value="The Reason for the appointment to take place."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/encounter-reason"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="AIS-3, SCH-7"/> </mapping> <mapping> <identity value="rim"/> <map value=".reasonCode"/> </mapping> </element> <element id="Appointment.indication"> <path value="Appointment.indication"/> <short value="Reason the appointment is to takes place (resource)"/> <definition value="Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.indication"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Procedure"/> </type> <mapping> <identity value="rim"/> <map value=".inboundRelationship[@typeCode = 'RSON'].observation"/> </mapping> </element> <element id="Appointment.priority"> <path value="Appointment.priority"/> <short value="Used to make informed decisions if needing to re-prioritize"/> <definition value="The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)."/> <comment value="Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a codeableconcept for named values may be tested at a future connectathon."/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.priority"/> <min value="0"/> <max value="1"/> </base> <type> <code value="unsignedInt"/> </type> <mapping> <identity value="v2"/> <map value="ARQ-12, SCH-11.6 / TQ1-9"/> </mapping> <mapping> <identity value="rim"/> <map value=".priorityCode"/> </mapping> <mapping> <identity value="ical"/> <map value="PRIORITY"/> </mapping> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="Appointment.description"> <path value="Appointment.description"/> <short value="Shown on a subject line in a meeting request, or appointment list"/> <definition value="The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field."/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="NTE-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="ical"/> <map value="DESCRIPTION"/> </mapping> </element> <element id="Appointment.supportingInformation"> <path value="Appointment.supportingInformation"/> <short value="Additional information to support the appointment"/> <definition value="Additional information to support the appointment provided when making the appointment."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.supportingInformation"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <mapping> <identity value="rim"/> <map value=".inboundRelationship[@typeCode = 'SPRT'].observation"/> </mapping> <mapping> <identity value="w5"/> <map value="context"/> </mapping> </element> <element id="Appointment.start"> <path value="Appointment.start"/> <short value="When appointment is to take place"/> <definition value="Date/Time that the appointment is to take place."/> <min value="1"/> <max value="1"/> <base> <path value="Appointment.start"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ARQ-11.1, SCH-11.4 / TQ1-7"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime.low"/> </mapping> <mapping> <identity value="w5"/> <map value="when.init"/> </mapping> </element> <element id="Appointment.end"> <path value="Appointment.end"/> <short value="When appointment is to conclude"/> <definition value="Date/Time that the appointment is to conclude."/> <min value="1"/> <max value="1"/> <base> <path value="Appointment.end"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime.high"/> </mapping> <mapping> <identity value="w5"/> <map value="when.done"/> </mapping> </element> <element id="Appointment.minutesDuration"> <path value="Appointment.minutesDuration"/> <short value="Can be less than start/end (e.g. estimate)"/> <definition value="Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request)."/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.minutesDuration"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <mapping> <identity value="rim"/> <map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width"/> </mapping> </element> <element id="Appointment.slot"> <path value="Appointment.slot"/> <short value="The slots that this appointment is filling"/> <definition value="The slots from the participants' schedules that will be filled by the appointment."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.slot"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Slot"/> </type> <mapping> <identity value="rim"/> <map value=".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']"/> </mapping> </element> <element id="Appointment.created"> <path value="Appointment.created"/> <short value="The date that this appointment was initially created"/> <definition value="The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment."/> <comment value="This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments."/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.created"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <mapping> <identity value="rim"/> <map value=".author.time"/> </mapping> </element> <element id="Appointment.comment"> <path value="Appointment.comment"/> <short value="Additional comments"/> <definition value="Additional comments about the appointment."/> <comment value="Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it."/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.comment"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="v2"/> <map value="NTE-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"/> </mapping> <mapping> <identity value="ical"/> <map value="COMMENT"/> </mapping> </element> <element id="Appointment.incomingReferral"> <path value="Appointment.incomingReferral"/> <short value="The ReferralRequest provided as information to allocate to the Encounter"/> <definition value="The referral request this appointment is allocated to assess (incoming referral)."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.incomingReferral"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ReferralRequest"/> </type> <mapping> <identity value="rim"/> <map value=".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']"/> </mapping> </element> <element id="Appointment.participant:p-1"> <path value="Appointment.participant"/> <sliceName value="p-1"/> <short value="Participants involved in appointment"/> <definition value="List of participants involved in the appointment."/> <min value="1"/> <max value="*"/> <base> <path value="Appointment.participant"/> <min value="1"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="app-1"/> <severity value="error"/> <human value="Either the type or actor on the participant SHALL be specified"/> <expression value="type.exists() or actor.exists()"/> <xpath value="(exists(f:type) or exists(f:actor))"/> <source value="Appointment.participant"/> </constraint> <mustSupport value="true"/> <mapping> <identity value="v2"/> <map value="PID, AIP, AIG, AIL"/> </mapping> <mapping> <identity value="rim"/> <map value="performer | reusableDevice | subject | location"/> </mapping> <mapping> <identity value="ical"/> <map value="ATTENDEE component to be created"/> </mapping> </element> <element id="Appointment.participant:p-1.id"> <path value="Appointment.participant.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Appointment.participant:p-1.extension"> <path value="Appointment.participant.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Appointment.participant:p-1.modifierExtension"> <path value="Appointment.participant.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Appointment.participant:p-1.type"> <path value="Appointment.participant.type"/> <short value="Role of participant in the appointment"/> <definition value="Role of participant in the appointment."/> <comment value="The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment."/> <min value="0"/> <max value="*"/> <base> <path value="Appointment.participant.type"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ParticipantType"/> </extension> <strength value="extensible"/> <description value="Role of participant in encounter."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/encounter-participant-type"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="AIP-4, AIG-4"/> </mapping> <mapping> <identity value="rim"/> <map value="(performer | reusableDevice | subject | location).@typeCode"/> </mapping> <mapping> <identity value="ical"/> <map value="n/a"/> </mapping> </element> <element id="Appointment.participant:p-1.actor"> <path value="Appointment.participant.actor"/> <short value="Person, Location/HealthcareService or Device"/> <definition value="A Person, Location/HealthcareService or Device that is participating in the appointment."/> <min value="1"/> <max value="1"/> <base> <path value="Appointment.participant.actor"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"/> </mapping> <mapping> <identity value="rim"/> <map value="performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"/> </mapping> <mapping> <identity value="ical"/> <map value="ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only""/> </mapping> <mapping> <identity value="w5"/> <map value="who"/> </mapping> </element> <element id="Appointment.participant:p-1.required"> <path value="Appointment.participant.required"/> <short value="required | optional | information-only"/> <definition value="Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present."/> <min value="0"/> <max value="1"/> <base> <path value="Appointment.participant.required"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ParticipantRequired"/> </extension> <strength value="required"/> <description value="Is the Participant required to attend the appointment."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/participantrequired"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="(performer | reusableDevice | subject | location).@performInd"/> </mapping> <mapping> <identity value="ical"/> <map value="ROLE=REQ-PARTICIPANT (roleparam)"/> </mapping> </element> <element id="Appointment.participant:p-1.status"> <path value="Appointment.participant.status"/> <short value="accepted | declined | tentative | needs-action"/> <definition value="Participation status of the actor."/> <min value="1"/> <max value="1"/> <base> <path value="Appointment.participant.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ParticipationStatus"/> </extension> <strength value="required"/> <description value="The Participation status of an appointment."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/participationstatus"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="AIP-12, AIG-14"/> </mapping> <mapping> <identity value="rim"/> <map value="(performer | reusableDevice | subject | location).statusCode"/> </mapping> <mapping> <identity value="ical"/> <map value="ATTENDEE;CN="Brian Postlethwaite";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"/> </mapping> </element> <element id="Appointment.requestedPeriod"> <path value="Appointment.requestedPeriod"/> <short value="Potential date/time interval(s) requested to allocate the appointment within"/> <definition value="A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time."/> <comment value="This does not introduce a capacity for recurring appointments."/> <min value="1"/> <max value="1"/> <base> <path value="Appointment.requestedPeriod"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Period"/> </type> <mustSupport value="true"/> <mapping> <identity value="v2"/> <map value="ARQ-11"/> </mapping> <mapping> <identity value="rim"/> <map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]"/> </mapping> </element> </snapshot> <differential> <element id="Appointment"> <path value="Appointment"/> <mustSupport value="false"/> </element> <element id="Appointment.id"> <path value="Appointment.id"/> <mustSupport value="true"/> </element> <element id="Appointment.extension:status-reason-extension"> <path value="Appointment.extension"/> <sliceName value="status-reason-extension"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-status-reason"/> </type> <mustSupport value="true"/> </element> <element id="Appointment.status"> <path value="Appointment.status"/> <mustSupport value="true"/> </element> <element id="Appointment.serviceType"> <path value="Appointment.serviceType"/> <min value="0"/> <max value="*"/> <mustSupport value="true"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://fhir.org/guides/argonaut-scheduling/ValueSet/visit-type"/> </valueSetReference> </binding> </element> <element id="Appointment.specialty"> <path value="Appointment.specialty"/> <min value="0"/> <max value="*"/> <mustSupport value="true"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://fhir.org/guides/argonaut-scheduling/ValueSet/specialty"/> </valueSetReference> </binding> </element> <element id="Appointment.appointmentType"> <path value="Appointment.appointmentType"/> <alias value="`"/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> <binding> <strength value="extensible"/> <valueSetReference> <reference value="http://fhir.org/guides/argonaut-scheduling/ValueSet/appt-type"/> </valueSetReference> </binding> </element> <element id="Appointment.start"> <path value="Appointment.start"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> </element> <element id="Appointment.end"> <path value="Appointment.end"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> </element> <element id="Appointment.participant:p-1"> <path value="Appointment.participant"/> <sliceName value="p-1"/> <min value="1"/> <max value="*"/> <type> <code value="BackboneElement"/> </type> <mustSupport value="true"/> </element> <element id="Appointment.participant:p-1.actor"> <path value="Appointment.participant.actor"/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> </type> <mustSupport value="true"/> </element> <element id="Appointment.participant:p-1.status"> <path value="Appointment.participant.status"/> <mustSupport value="true"/> </element> <element id="Appointment.requestedPeriod"> <path value="Appointment.requestedPeriod"/> <min value="1"/> <max value="1"/> <mustSupport value="true"/> </element> </differential> </StructureDefinition>
