. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
StructureDefinition for appointment
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Appointment"/> <meta> <lastUpdated value="2015-03-27T00:13:00.999+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/Appointment"/> <name value="Appointment"/> <publisher value="HL7 FHIR Project (Patient Administration)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/pafm/index.cfm"/> </telecom> </contact> <description value="Base StructureDefinition for Appointment Resource"/> <status value="draft"/> <date value="2015-03-27T00:13:00+11:00"/> <mapping> <identity value="ical"/> <uri value="http://www.ietf.org/rfc/rfc2445.txt"/> <name value="iCalendar"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2"/> </mapping> <type value="resource"/> <abstract value="true"/> <snapshot> <element> <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="1"/> <max value="1"/> <type> <code value="Appointment"/> </type> <mapping> <identity value="ical"/> <map value="VEVENT"/> </mapping> <mapping> <identity value="rim"/> <map value="Act (ActMood = ActMoodAppointment or ActMoodAppointmentRequest)"/> </mapping> </element> <element> <path value="Appointment.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments 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. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <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"/> <type> <code value="Meta"/> </type> </element> <element> <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."/> <comments 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 as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="Appointment.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments 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"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <strength value="required"/> <description value="A human language"/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <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."/> <comments 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="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Appointment.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 resource. 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."/> <comments 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="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <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."/> <comments 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="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <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 processed 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="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="ical"/> <map value="UID"/> </mapping> <mapping> <identity value="v2"/> <map value="SCH-1, SCH-2, ARQ-1, ARQ-2"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="Appointment.status"/> <short value="pending | booked | arrived | fulfilled | cancelled | noshow"/> <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."/> <comments 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 Slot's that were marked as BUSY can be re-set to FREE."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <name value="AppointmentStatus"/> <strength value="required"/> <description value="The free/busy status of an appointment"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/appointmentstatus"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="SCH-25"/> </mapping> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> </element> <element> <path value="Appointment.type"/> <short value="The type of appointment that is being booked"/> <definition value="The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="DocumentC80PracticeSetting"/> <strength value="preferred"/> <description value="Additional details about where the content was created (e.g. clinical specialty)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/c80-practice-codes"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Appointment.reason"/> <short value="The reason that this appointment is being scheduled, this is more clinical than administrative"/> <definition value="The reason that this appointment is being scheduled, this is more clinical than administrative."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="ApptReason"/> <strength value="required"/> <description value="The Reason for the appointment to take place"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/encounter-reason"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="AIS-3, ARQ-7"/> </mapping> <mapping> <identity value="rim"/> <map value="(encounter appointment).reason"/> </mapping> </element> <element> <path value="Appointment.priority"/> <short 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)"/> <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)."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <mapping> <identity value="ical"/> <map value="PRIORITY"/> </mapping> <mapping> <identity value="v2"/> <map value="ARQ-12, SCH-11.6 / TQ1-9"/> </mapping> <mapping> <identity value="rim"/> <map value=".priorityCode"/> </mapping> </element> <element> <path value="Appointment.description"/> <short 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"/> <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"/> <type> <code value="string"/> </type> <mapping> <identity value="ical"/> <map value="DESCRIPTION"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> <element> <path value="Appointment.start"/> <short value="Date/Time that the appointment is to take place"/> <definition value="Date/Time that the appointment is to take place."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <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> </element> <element> <path value="Appointment.end"/> <short value="Date/Time that the appointment is to conclude"/> <definition value="Date/Time that the appointment is to conclude."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ARQ-11.2, SCH-11.5 / TQ1-8"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime.high"/> </mapping> </element> <element> <path value="Appointment.slot"/> <short value="The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot"/> <definition value="The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Slot"/> </type> <mapping> <identity value="rim"/> <map value="Schedule-Slot (classCode=ACT, moodCode = SLOT)"/> </mapping> </element> <element> <path value="Appointment.comment"/> <short value="Additional comments about the appointment"/> <definition value="Additional comments about the appointment."/> <comments value="Additional text to aid in facilitating the appointment. For instance, a comment might be, “patient should proceed immediately to infusion room upon arrival”."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="ical"/> <map value="COMMENT"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE-3"/> </mapping> </element> <element> <path value="Appointment.order"/> <short value="An Order that lead to the creation of this appointment"/> <definition value="An Order that lead to the creation of this appointment."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Order"/> </type> <mapping> <identity value="v2"/> <map value="ARQ-24, SCH-26"/> </mapping> <mapping> <identity value="rim"/> <map value=".referencedOrder"/> </mapping> </element> <element> <path value="Appointment.participant"/> <short value="List of participants involved in the appointment"/> <definition value="List of participants involved in the appointment."/> <min value="1"/> <max value="*"/> <mapping> <identity value="ical"/> <map value="ATTENDEE component to be created"/> </mapping> <mapping> <identity value="v2"/> <map value="PID, AIP, AIG, AIL"/> </mapping> </element> <element> <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)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <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."/> <comments 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="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <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."/> <comments 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="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Appointment.participant.type"/> <short value="Role of participant in the appointment"/> <definition value="Role of participant in the appointment."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="ParticipantType"/> <strength value="required"/> <description value="Role of participant in encounter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/encounter-participant-type"/> </valueSetReference> </binding> <mapping> <identity value="ical"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="AIP-4, AIG-4"/> </mapping> </element> <element> <path value="Appointment.participant.actor"/> <short value="A Person, Location/HealthcareService or Device that is participating in the appointment"/> <definition value="A Person, Location/HealthcareService or Device that is participating in the appointment."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <isSummary value="true"/> <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="v2"/> <map value="PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"/> </mapping> <mapping> <identity value="rim"/> <map value="performer | reusableDevice | subject | location"/> </mapping> </element> <element> <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"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="ParticipantRequired"/> <strength value="required"/> <description value="Is the Participant required to attend the appointment"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/participantrequired"/> </valueSetReference> </binding> <mapping> <identity value="ical"/> <map value="ROLE=REQ-PARTICIPANT (roleparam)"/> </mapping> <mapping> <identity value="rim"/> <map value="performer.performIndicator"/> </mapping> </element> <element> <path value="Appointment.participant.status"/> <short value="accepted | declined | tentative | needs-action"/> <definition value="Participation status of the Patient."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="ParticipationStatus"/> <strength value="required"/> <description value="The Participation status of an appointment"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/participationstatus"/> </valueSetReference> </binding> <mapping> <identity value="ical"/> <map value="ATTENDEE;CN="Brian Postlethwaite";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"/> </mapping> <mapping> <identity value="v2"/> <map value="AIP-12, AIG-14"/> </mapping> </element> </snapshot> <differential> <element> <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="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <mapping> <identity value="ical"/> <map value="VEVENT"/> </mapping> <mapping> <identity value="rim"/> <map value="Act (ActMood = ActMoodAppointment or ActMoodAppointmentRequest)"/> </mapping> </element> <element> <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 processed 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="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="ical"/> <map value="UID"/> </mapping> <mapping> <identity value="v2"/> <map value="SCH-1, SCH-2, ARQ-1, ARQ-2"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="Appointment.status"/> <short value="pending | booked | arrived | fulfilled | cancelled | noshow"/> <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."/> <comments 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 Slot's that were marked as BUSY can be re-set to FREE."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <name value="AppointmentStatus"/> <strength value="required"/> <description value="The free/busy status of an appointment"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/appointmentstatus"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="SCH-25"/> </mapping> <mapping> <identity value="rim"/> <map value=".statusCode"/> </mapping> </element> <element> <path value="Appointment.type"/> <short value="The type of appointment that is being booked"/> <definition value="The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService)."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="DocumentC80PracticeSetting"/> <strength value="preferred"/> <description value="Additional details about where the content was created (e.g. clinical specialty)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/c80-practice-codes"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="Appointment.reason"/> <short value="The reason that this appointment is being scheduled, this is more clinical than administrative"/> <definition value="The reason that this appointment is being scheduled, this is more clinical than administrative."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="ApptReason"/> <strength value="required"/> <description value="The Reason for the appointment to take place"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/encounter-reason"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="AIS-3, ARQ-7"/> </mapping> <mapping> <identity value="rim"/> <map value="(encounter appointment).reason"/> </mapping> </element> <element> <path value="Appointment.priority"/> <short 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)"/> <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)."/> <min value="0"/> <max value="1"/> <type> <code value="integer"/> </type> <mapping> <identity value="ical"/> <map value="PRIORITY"/> </mapping> <mapping> <identity value="v2"/> <map value="ARQ-12, SCH-11.6 / TQ1-9"/> </mapping> <mapping> <identity value="rim"/> <map value=".priorityCode"/> </mapping> </element> <element> <path value="Appointment.description"/> <short 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"/> <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"/> <type> <code value="string"/> </type> <mapping> <identity value="ical"/> <map value="DESCRIPTION"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE-3"/> </mapping> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> <element> <path value="Appointment.start"/> <short value="Date/Time that the appointment is to take place"/> <definition value="Date/Time that the appointment is to take place."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <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> </element> <element> <path value="Appointment.end"/> <short value="Date/Time that the appointment is to conclude"/> <definition value="Date/Time that the appointment is to conclude."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="ARQ-11.2, SCH-11.5 / TQ1-8"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime.high"/> </mapping> </element> <element> <path value="Appointment.slot"/> <short value="The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot"/> <definition value="The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Slot"/> </type> <mapping> <identity value="rim"/> <map value="Schedule-Slot (classCode=ACT, moodCode = SLOT)"/> </mapping> </element> <element> <path value="Appointment.comment"/> <short value="Additional comments about the appointment"/> <definition value="Additional comments about the appointment."/> <comments value="Additional text to aid in facilitating the appointment. For instance, a comment might be, “patient should proceed immediately to infusion room upon arrival”."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="ical"/> <map value="COMMENT"/> </mapping> <mapping> <identity value="v2"/> <map value="NTE-3"/> </mapping> </element> <element> <path value="Appointment.order"/> <short value="An Order that lead to the creation of this appointment"/> <definition value="An Order that lead to the creation of this appointment."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Order"/> </type> <mapping> <identity value="v2"/> <map value="ARQ-24, SCH-26"/> </mapping> <mapping> <identity value="rim"/> <map value=".referencedOrder"/> </mapping> </element> <element> <path value="Appointment.participant"/> <short value="List of participants involved in the appointment"/> <definition value="List of participants involved in the appointment."/> <min value="1"/> <max value="*"/> <mapping> <identity value="ical"/> <map value="ATTENDEE component to be created"/> </mapping> <mapping> <identity value="v2"/> <map value="PID, AIP, AIG, AIL"/> </mapping> </element> <element> <path value="Appointment.participant.type"/> <short value="Role of participant in the appointment"/> <definition value="Role of participant in the appointment."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="ParticipantType"/> <strength value="required"/> <description value="Role of participant in encounter"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/encounter-participant-type"/> </valueSetReference> </binding> <mapping> <identity value="ical"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="AIP-4, AIG-4"/> </mapping> </element> <element> <path value="Appointment.participant.actor"/> <short value="A Person, Location/HealthcareService or Device that is participating in the appointment"/> <definition value="A Person, Location/HealthcareService or Device that is participating in the appointment."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <isSummary value="true"/> <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="v2"/> <map value="PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"/> </mapping> <mapping> <identity value="rim"/> <map value="performer | reusableDevice | subject | location"/> </mapping> </element> <element> <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"/> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <name value="ParticipantRequired"/> <strength value="required"/> <description value="Is the Participant required to attend the appointment"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/participantrequired"/> </valueSetReference> </binding> <mapping> <identity value="ical"/> <map value="ROLE=REQ-PARTICIPANT (roleparam)"/> </mapping> <mapping> <identity value="rim"/> <map value="performer.performIndicator"/> </mapping> </element> <element> <path value="Appointment.participant.status"/> <short value="accepted | declined | tentative | needs-action"/> <definition value="Participation status of the Patient."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="ParticipationStatus"/> <strength value="required"/> <description value="The Participation status of an appointment"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/participationstatus"/> </valueSetReference> </binding> <mapping> <identity value="ical"/> <map value="ATTENDEE;CN="Brian Postlethwaite";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"/> </mapping> <mapping> <identity value="v2"/> <map value="AIP-12, AIG-14"/> </mapping> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:17+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change