{ "resourceType": "StructureDefinition", "id": "Appointment", "meta": { "lastUpdated": "2021-01-01T21:58:31.578+00:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString": "Base.Workflow" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 3 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode": "patient" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status", "valueCode": ".status=entered-in-error" } ], "url": "http://hl7.org/fhir/StructureDefinition/Appointment", "version": "4.6.0", "name": "Appointment", "status": "draft", "date": "2021-01-01T21:58:31+00:00", "publisher": "Health Level Seven International (Patient Administration)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/pafm/index.cfm" } ] } ], "description": "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).", "fhirVersion": "4.6.0", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "ical", "uri": "http://ietf.org/rfc/2445", "name": "iCalendar" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" } ], "kind": "resource", "abstract": false, "type": "Appointment", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "differential": { "element": [ { "id": "Appointment", "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": "*", "constraint": [ { "key": "app-5", "severity": "error", "human": "The start must be less than or equal to the end", "expression": "start.exists() implies start <= end", "xpath": "f:start <= f:end or not(start.exists() and end.exists())", "source": "http://hl7.org/fhir/StructureDefinition/Questionnaire" }, { "key": "app-4", "severity": "error", "human": "Cancellation reason is only used for appointments that have been cancelled, or no-show", "expression": "cancellationReason.exists() implies (status='no-show' or status='cancelled')", "xpath": "not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" }, { "key": "app-3", "severity": "error", "human": "Only proposed or cancelled appointments can be missing start/end dates", "expression": "(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))", "xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" }, { "key": "app-2", "severity": "error", "human": "Either start and end are specified, or neither", "expression": "start.exists() = end.exists()", "xpath": "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" } ], "mapping": [ { "identity": "workflow", "map": "Request" }, { "identity": "rim", "map": "Act[@moodCode <= 'INT']" }, { "identity": "ical", "map": "VEVENT" }, { "identity": "w5", "map": "workflow.scheduling" } ] }, { "id": "Appointment.identifier", "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": "workflow", "map": "Request.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "SCH-1, SCH-2, ARQ-1, ARQ-2" }, { "identity": "rim", "map": ".id" }, { "identity": "ical", "map": "UID" } ] }, { "id": "Appointment.status", "path": "Appointment.status", "short": "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist", "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.", "comment": "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.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AppointmentStatus" } ], "strength": "required", "description": "The free/busy status of an appointment.", "valueSet": "http://hl7.org/fhir/ValueSet/appointmentstatus" }, "mapping": [ { "identity": "workflow", "map": "Request.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "v2", "map": "SCH-25" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "ical", "map": "STATUS" } ] }, { "id": "Appointment.cancellationReason", "path": "Appointment.cancellationReason", "short": "The coded reason for the appointment being cancelled", "definition": "The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "cancellation-reason" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/appointment-cancellation-reason" }, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.serviceCategory", "path": "Appointment.serviceCategory", "short": "A broad categorization of the service that is to be performed during this appointment", "definition": "A broad categorization of the service that is to be performed during this appointment.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-category" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-category" }, "mapping": [ { "identity": "rim", "map": "n/a, might be inferred from the ServiceDeliveryLocation" }, { "identity": "ical", "map": "CATEGORIES" } ] }, { "id": "Appointment.serviceType", "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.", "comment": "For a provider to provider appointment the code \"FOLLOWUP\" may be appropriate, as this is expected to be discussing some patient that was seen in the past.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "service-type" } ], "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/service-type" }, "mapping": [ { "identity": "workflow", "map": "Request.code" }, { "identity": "v2", "map": "ARQ-8, SCH-8" }, { "identity": "rim", "map": "n/a, might be inferred from the ServiceDeliveryLocation" } ] }, { "id": "Appointment.specialty", "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": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "specialty" } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes" }, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".performer.AssignedPerson.code" } ] }, { "id": "Appointment.appointmentType", "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": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "appointment-type" } ], "strength": "preferred", "valueSet": "http://terminology.hl7.org/ValueSet/v2-0276" }, "mapping": [ { "identity": "v2", "map": "ARQ-7, SCH-7" }, { "identity": "rim", "map": ".code" }, { "identity": "ical", "map": "CLASSIFICATION" } ] }, { "id": "Appointment.reason", "path": "Appointment.reason", "short": "Reason this appointment is scheduled", "definition": "The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or 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": 0, "max": "*", "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" ] } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ApptReason" } ], "strength": "preferred", "description": "The Reason for the appointment to take place.", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason" }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode" }, { "identity": "v2", "map": "AIS-3" }, { "identity": "rim", "map": ".reasonCode" } ] }, { "id": "Appointment.priority", "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).", "comment": "Seeking implementer feedback on this property and how interoperable it is.\r\rUsing an extension to record a CodeableConcept for named values may be tested at a future connectathon.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Priority" }, { "url": "http://hl7.org/fhir/build/StructureDefinition/definition", "valueString": "Indicates the urgency of the appointment." } ], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority" }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "ARQ-12, SCH-11.6 / TQ1-9" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "ical", "map": "PRIORITY" } ] }, { "id": "Appointment.description", "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": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".text" }, { "identity": "ical", "map": "SUMMARY" } ] }, { "id": "Appointment.replaces", "path": "Appointment.replaces", "short": "Appointment replaced by this Appointment", "definition": "Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Appointment" ] } ], "mapping": [ { "identity": "workflow", "map": "Request.replaces" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": ".inboundRelationship[@typeCode = 'SPRT'].observation" }, { "identity": "ical", "map": "ATTACH" } ] }, { "id": "Appointment.supportingInformation", "path": "Appointment.supportingInformation", "short": "Additional information to support the appointment", "definition": "Additional information to support the appointment provided when making the appointment.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ] } ], "mapping": [ { "identity": "workflow", "map": "Request.supportingInfo" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": ".inboundRelationship[@typeCode = 'SPRT'].observation" }, { "identity": "ical", "map": "ATTACH" } ] }, { "id": "Appointment.start", "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": "workflow", "map": "Request.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.init" }, { "identity": "v2", "map": "ARQ-11.1, SCH-11.4 / TQ1-7" }, { "identity": "rim", "map": ".effectiveTime.low" }, { "identity": "ical", "map": "DTSTART" } ] }, { "id": "Appointment.end", "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": "workflow", "map": "Request.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "v2", "map": "SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9" }, { "identity": "rim", "map": ".effectiveTime.high" }, { "identity": "ical", "map": "DTEND" } ] }, { "id": "Appointment.minutesDuration", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes", "valueString": "Removed when taking out the recurrence fields." } ], "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. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "rim", "map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width" }, { "identity": "ical", "map": "DURATION (e.g. PT15M)" } ] }, { "id": "Appointment.slot", "path": "Appointment.slot", "short": "The slots that this appointment is filling", "definition": "The slots from the participants' schedules that will be filled by the appointment.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Slot" ] } ], "mapping": [ { "identity": "rim", "map": ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']" } ] }, { "id": "Appointment.account", "path": "Appointment.account", "short": "The set of accounts that may be used for billing for this Appointment", "definition": "The set of accounts that is expected to be used for billing the activities that result from this Appointment.", "comment": "The specified account(s) could be those identified during pre-registration workflows in preparation for an upcoming Encounter.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Account" ] } ], "mapping": [ { "identity": "rim", "map": ".pertains.A_Account" } ] }, { "id": "Appointment.created", "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.", "comment": "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" } ], "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "rim", "map": ".author.time" }, { "identity": "ical", "map": "CREATED" } ] }, { "id": "Appointment.note", "path": "Appointment.note", "short": "Additional comments", "definition": "Additional notes/comments about the appointment.", "comment": "Additional text to aid in facilitating the appointment. For instance, a note might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere 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.\r\rTypically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Request.note" }, { "identity": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" }, { "identity": "ical", "map": "DESCRIPTION (for internal use)" } ] }, { "id": "Appointment.patientInstruction", "path": "Appointment.patientInstruction", "short": "Detailed information and instructions for the patient", "definition": "While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).", "min": 0, "max": "*", "type": [ { "code": "CodeableReference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DocumentReference", "http://hl7.org/fhir/StructureDefinition/Binary", "http://hl7.org/fhir/StructureDefinition/Communication" ] } ], "mapping": [ { "identity": "v2", "map": "NTE-3" }, { "identity": "rim", "map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" }, { "identity": "ical", "map": "DESCRIPTION (for patient use)" } ] }, { "id": "Appointment.basedOn", "path": "Appointment.basedOn", "short": "The service request this appointment is allocated to assess", "definition": "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).", "alias": [ "incomingReferral" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ] } ], "mapping": [ { "identity": "workflow", "map": "Request.basedOn" }, { "identity": "rim", "map": ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']" } ] }, { "id": "Appointment.subject", "path": "Appointment.subject", "short": "The patient or group associated with the appointment", "definition": "The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group" ] } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.who" }, { "identity": "v2", "map": "PID-3-Patient ID List" }, { "identity": "rim", "map": "subject.patient" } ] }, { "id": "Appointment.participant", "extension": [ { "url": "http://hl7.org/fhir/build/StructureDefinition/uml-dir", "valueCode": "right" } ], "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 SHALL be specified", "expression": "type.exists() or actor.exists()", "xpath": "(exists(f:type) or exists(f:actor))", "source": "http://hl7.org/fhir/StructureDefinition/Appointment" } ], "mapping": [ { "identity": "workflow", "map": "Request.performer, Request.subject" }, { "identity": "v2", "map": "PID, AIP, AIG, AIL" }, { "identity": "rim", "map": "performer | reusableDevice | subject | location" }, { "identity": "ical", "map": "ATTENDEE component to be created" } ] }, { "id": "Appointment.participant.type", "path": "Appointment.participant.type", "short": "Role of participant in the appointment", "definition": "Role of participant in the appointment.", "comment": "The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL 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": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipantType" } ], "strength": "extensible", "description": "Role of participant in encounter.", "valueSet": "http://hl7.org/fhir/ValueSet/encounter-participant-type" }, "mapping": [ { "identity": "v2", "map": "AIP-4, AIG-4" }, { "identity": "rim", "map": "(performer | reusableDevice | subject | location).@typeCode" }, { "identity": "ical", "map": "n/a" } ] }, { "id": "Appointment.participant.period", "path": "Appointment.participant.period", "short": "Participation period of the actor", "definition": "Participation period of the actor.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Appointment.participant.actor", "path": "Appointment.participant.actor", "short": "Person, Location/HealthcareService or Device", "definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.", "comment": "Where a CareTeam is provided, this does not imply that the entire team is included, just a single member from the group with the appropriate role. Where multiple members are required, please include the CareTeam the required number of times.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.who" }, { "identity": "v2", "map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3" }, { "identity": "rim", "map": "performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation" }, { "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\"" } ] }, { "id": "Appointment.participant.required", "path": "Appointment.participant.required", "short": "The participant is required to attend (optional when false)", "definition": "Whether this participant is required to be present at the meeting. If false, the participant is optional.", "comment": "For the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": "(performer | reusableDevice | subject | location).@performInd" }, { "identity": "ical", "map": "ROLE=REQ-PARTICIPANT (roleparam)" } ] }, { "id": "Appointment.participant.status", "path": "Appointment.participant.status", "short": "accepted | declined | tentative | needs-action", "definition": "Participation status of the actor.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ParticipationStatus" } ], "strength": "required", "description": "The Participation status of an appointment.", "valueSet": "http://hl7.org/fhir/ValueSet/participationstatus" }, "mapping": [ { "identity": "v2", "map": "AIP-12, AIG-14" }, { "identity": "rim", "map": "(performer | reusableDevice | subject | location).statusCode" }, { "identity": "ical", "map": "ATTENDEE;CN=\"John Doe\";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)" } ] }, { "id": "Appointment.requestedPeriod", "path": "Appointment.requestedPeriod", "short": "Potential date/time interval(s) requested to allocate the appointment within", "definition": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\n\nThe duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.", "comment": "This does not introduce a capacity for recurring appointments.", "min": 0, "max": "*", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "workflow", "map": "Request.occurrence[x]" }, { "identity": "v2", "map": "ARQ-11" }, { "identity": "rim", "map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]" } ] } ] } }