STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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
{
"resourceType": "StructureDefinition",
"id": "Appointment",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Appointment",
"name": "Appointment",
"status": "draft",
"publisher": "Health Level Seven International (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for Appointment Resource",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "ical",
"uri": "http://www.ietf.org/rfc/rfc2445.txt",
"name": "iCalendar"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"kind": "resource",
"abstract": false,
"baseType": "DomainResource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"path": "Appointment",
"short": "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": "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": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "app-3",
"severity": "error",
"human": "Only proposed or cancelled appointments can be missing start/end dates",
"expression": "(start and end) or status = 'proposed' or status = 'cancelled'",
"xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled'))"
},
{
"key": "app-2",
"severity": "error",
"human": "Either start and end are specified, or neither",
"expression": "start.empty() xor end",
"xpath": "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))"
}
],
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
},
{
"identity": "rim",
"map": "Act (ActMood = ActMoodAppointment or ActMoodAppointmentRequest)"
},
{
"identity": "w5",
"map": "workflow.scheduling"
}
]
},
{
"path": "Appointment.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "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": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "Appointment.meta",
"short": "Metadata about the resource",
"definition": "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": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"path": "Appointment.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "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": "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": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Appointment.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Appointment.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "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": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Appointment.contained",
"short": "Contained, inline Resources",
"definition": "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": "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": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.extension",
"short": "Additional Content defined by implementations",
"definition": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.identifier",
"short": "External Ids for this item",
"definition": "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": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "v2",
"map": "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Appointment.status",
"short": "proposed | pending | booked | arrived | fulfilled | cancelled | noshow",
"definition": "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": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The free/busy status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/appointmentstatus"
}
},
"mapping": [
{
"identity": "v2",
"map": "SCH-25"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "Appointment.serviceCategory",
"short": "A broad categorisation of the service that is to be performed during this appointment",
"definition": "A broad categorisation of the service that is to be performed during this appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-category"
}
}
},
{
"path": "Appointment.serviceType",
"short": "The specific service that is to be performed during this appointment",
"definition": "The specific service that is to be performed during this appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-type"
}
}
},
{
"path": "Appointment.specialty",
"short": "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "Appointment.appointmentType",
"short": "The style of appointment or patient that has been booked in the slot (not service type)",
"definition": "The style of appointment or patient that has been booked in the slot (not service type).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0276"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Appointment.reason",
"short": "Reason this appointment is scheduled",
"definition": "The reason that this appointment is being scheduled. This is more clinical than administrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "The Reason for the appointment to take place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "AIS-3, ARQ-7, SCH-7"
},
{
"identity": "rim",
"map": "(encounter appointment).reason"
}
]
},
{
"path": "Appointment.priority",
"short": "Used to make informed decisions if needing to re-prioritize",
"definition": "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).",
"comments": "Seeking implementer feedback on this property and how interoperable it is.\n\nUsing an extension to record a codeableconcept for named values may be tested at a future connectathon.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "ical",
"map": "PRIORITY"
},
{
"identity": "v2",
"map": "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity": "rim",
"map": ".priorityCode"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "Appointment.description",
"short": "Shown on a subject line in a meeting request, or appointment list",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "DESCRIPTION"
},
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Appointment.start",
"short": "When appointment is to take place",
"definition": "Date/Time that the appointment is to take place.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity": "rim",
"map": ".effectiveTime.low"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"path": "Appointment.end",
"short": "When appointment is to conclude",
"definition": "Date/Time that the appointment is to conclude.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.2, SCH-11.5 / TQ1-8"
},
{
"identity": "rim",
"map": ".effectiveTime.high"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"path": "Appointment.minutesDuration",
"short": "Can be less than start/end (e.g. estimate)",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
},
{
"path": "Appointment.slot",
"short": "If provided, then no schedule and start/end values MUST match slot",
"definition": "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": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Slot"
]
}
],
"mapping": [
{
"identity": "rim",
"map": "Schedule-Slot (classCode=ACT, moodCode = SLOT)"
}
]
},
{
"path": "Appointment.created",
"short": "The date that this appointment was initially created",
"definition": "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.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Appointment.comment",
"short": "Additional comments",
"definition": "Additional comments about the appointment.",
"comments": "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\n\nWhere 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": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
},
{
"identity": "v2",
"map": "NTE-3"
}
]
},
{
"path": "Appointment.participant",
"short": "Participants involved in appointment",
"definition": "List of participants involved in the appointment.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "app-1",
"severity": "error",
"human": "Either the type or actor on the participant MUST be specified",
"expression": "type or actor",
"xpath": "(exists(f:type) or exists(f:actor))"
}
],
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE component to be created"
},
{
"identity": "v2",
"map": "PID, AIP, AIG, AIL"
}
]
},
{
"path": "Appointment.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Appointment.participant.extension",
"short": "Additional Content defined by implementations",
"definition": "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": "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": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Appointment.participant.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "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": "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": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.participant.type",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"comments": "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\n\nIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\n\nThis value MUST be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Role of participant in encounter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
},
{
"identity": "v2",
"map": "AIP-4, AIG-4"
}
]
},
{
"path": "Appointment.participant.actor",
"short": "Person, Location/HealthcareService or Device",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/HealthcareService"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Location"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "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\""
},
{
"identity": "v2",
"map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"
},
{
"identity": "rim",
"map": "performer | reusableDevice | subject | location"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"path": "Appointment.participant.required",
"short": "required | optional | information-only",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Is the Participant required to attend the appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participantrequired"
}
},
"mapping": [
{
"identity": "ical",
"map": "ROLE=REQ-PARTICIPANT (roleparam)"
},
{
"identity": "rim",
"map": "performer.performIndicator"
}
]
},
{
"path": "Appointment.participant.status",
"short": "accepted | declined | tentative | needs-action",
"definition": "Participation status of the Patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The Participation status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participationstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
},
{
"identity": "v2",
"map": "AIP-12, AIG-14"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Appointment",
"short": "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": "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": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "app-3",
"severity": "error",
"human": "Only proposed or cancelled appointments can be missing start/end dates",
"expression": "(start and end) or status = 'proposed' or status = 'cancelled'",
"xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled'))"
},
{
"key": "app-2",
"severity": "error",
"human": "Either start and end are specified, or neither",
"expression": "start.empty() xor end",
"xpath": "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))"
}
],
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
},
{
"identity": "rim",
"map": "Act (ActMood = ActMoodAppointment or ActMoodAppointmentRequest)"
},
{
"identity": "w5",
"map": "workflow.scheduling"
}
]
},
{
"path": "Appointment.identifier",
"short": "External Ids for this item",
"definition": "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": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "v2",
"map": "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "Appointment.status",
"short": "proposed | pending | booked | arrived | fulfilled | cancelled | noshow",
"definition": "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": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The free/busy status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/appointmentstatus"
}
},
"mapping": [
{
"identity": "v2",
"map": "SCH-25"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "Appointment.serviceCategory",
"short": "A broad categorisation of the service that is to be performed during this appointment",
"definition": "A broad categorisation of the service that is to be performed during this appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-category"
}
}
},
{
"path": "Appointment.serviceType",
"short": "The specific service that is to be performed during this appointment",
"definition": "The specific service that is to be performed during this appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-type"
}
}
},
{
"path": "Appointment.specialty",
"short": "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
}
},
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "Appointment.appointmentType",
"short": "The style of appointment or patient that has been booked in the slot (not service type)",
"definition": "The style of appointment or patient that has been booked in the slot (not service type).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0276"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Appointment.reason",
"short": "Reason this appointment is scheduled",
"definition": "The reason that this appointment is being scheduled. This is more clinical than administrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "preferred",
"description": "The Reason for the appointment to take place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "AIS-3, ARQ-7, SCH-7"
},
{
"identity": "rim",
"map": "(encounter appointment).reason"
}
]
},
{
"path": "Appointment.priority",
"short": "Used to make informed decisions if needing to re-prioritize",
"definition": "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).",
"comments": "Seeking implementer feedback on this property and how interoperable it is.\n\nUsing an extension to record a codeableconcept for named values may be tested at a future connectathon.",
"min": 0,
"max": "1",
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "ical",
"map": "PRIORITY"
},
{
"identity": "v2",
"map": "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity": "rim",
"map": ".priorityCode"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "Appointment.description",
"short": "Shown on a subject line in a meeting request, or appointment list",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "DESCRIPTION"
},
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Appointment.start",
"short": "When appointment is to take place",
"definition": "Date/Time that the appointment is to take place.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity": "rim",
"map": ".effectiveTime.low"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"path": "Appointment.end",
"short": "When appointment is to conclude",
"definition": "Date/Time that the appointment is to conclude.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.2, SCH-11.5 / TQ1-8"
},
{
"identity": "rim",
"map": ".effectiveTime.high"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"path": "Appointment.minutesDuration",
"short": "Can be less than start/end (e.g. estimate)",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "positiveInt"
}
]
},
{
"path": "Appointment.slot",
"short": "If provided, then no schedule and start/end values MUST match slot",
"definition": "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": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Slot"
]
}
],
"mapping": [
{
"identity": "rim",
"map": "Schedule-Slot (classCode=ACT, moodCode = SLOT)"
}
]
},
{
"path": "Appointment.created",
"short": "The date that this appointment was initially created",
"definition": "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.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Appointment.comment",
"short": "Additional comments",
"definition": "Additional comments about the appointment.",
"comments": "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\n\nWhere 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": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
},
{
"identity": "v2",
"map": "NTE-3"
}
]
},
{
"path": "Appointment.participant",
"short": "Participants involved in appointment",
"definition": "List of participants involved in the appointment.",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "app-1",
"severity": "error",
"human": "Either the type or actor on the participant MUST be specified",
"expression": "type or actor",
"xpath": "(exists(f:type) or exists(f:actor))"
}
],
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE component to be created"
},
{
"identity": "v2",
"map": "PID, AIP, AIG, AIL"
}
]
},
{
"path": "Appointment.participant.type",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"comments": "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\n\nIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\n\nThis value MUST be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Role of participant in encounter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
},
{
"identity": "v2",
"map": "AIP-4, AIG-4"
}
]
},
{
"path": "Appointment.participant.actor",
"short": "Person, Location/HealthcareService or Device",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/HealthcareService"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Location"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "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\""
},
{
"identity": "v2",
"map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"
},
{
"identity": "rim",
"map": "performer | reusableDevice | subject | location"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"path": "Appointment.participant.required",
"short": "required | optional | information-only",
"definition": "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": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Is the Participant required to attend the appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participantrequired"
}
},
"mapping": [
{
"identity": "ical",
"map": "ROLE=REQ-PARTICIPANT (roleparam)"
},
{
"identity": "rim",
"map": "performer.performIndicator"
}
]
},
{
"path": "Appointment.participant.status",
"short": "accepted | declined | tentative | needs-action",
"definition": "Participation status of the Patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The Participation status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participationstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
},
{
"identity": "v2",
"map": "AIP-12, AIG-14"
}
]
}
]
}
}
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 STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:07+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change