Pan-Canadian eReferral-eConsult (CA:eReC) CIBuild

preBallot - The specification is currently in ballot review and subject to change. . . . For a full list of available versions, see the Directory of published versions

Appointment (CA:eReC)

Description

The resource involves booking one (or a series) of appointment(s) between the patient and the practitioner(s) for a specific date/time. The encounter may be a scheduled referral or an econsult.

References to this resource

Resource Content

Appointment			Appointment	There are no (further) constraints on this element Data type Appointment
text	S			There are no (further) constraints on this element Element id Appointment.text
status	S			There are no (further) constraints on this element Element id Appointment.status
description	S			There are no (further) constraints on this element Element id Appointment.description
start	S			There are no (further) constraints on this element Element id Appointment.start
end				There are no (further) constraints on this element Element id Appointment.end Comments 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported.
minutesDuration				There are no (further) constraints on this element Element id Appointment.minutesDuration Comments 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported.
created	S			There are no (further) constraints on this element Element id Appointment.created
comment	S			There are no (further) constraints on this element Element id Appointment.comment
patientInstruction				There are no (further) constraints on this element Element id Appointment.patientInstruction Comments If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field.
basedOn	S	1..1	Reference(ServiceRequest)	There are no (further) constraints on this element Element id Appointment.basedOn Data type Reference(ServiceRequest)
reference	S			There are no (further) constraints on this element Element id Appointment.basedOn.reference
identifier	S			There are no (further) constraints on this element Element id Appointment.basedOn.identifier
use	S	1..		There are no (further) constraints on this element Element id Appointment.basedOn.identifier.use
system	S	1..		There are no (further) constraints on this element Element id Appointment.basedOn.identifier.system
value	S	1..		There are no (further) constraints on this element Element id Appointment.basedOn.identifier.value
participant	S			There are no (further) constraints on this element Element id Appointment.participant
type	S			There are no (further) constraints on this element Element id Appointment.participant.type
actor	S		Reference(Patient \| PractitionerRole \| Location)	There are no (further) constraints on this element Element id Appointment.participant.actor Data type Reference(Patient \| PractitionerRole \| Location)
reference	S			There are no (further) constraints on this element Element id Appointment.participant.actor.reference
identifier	S			There are no (further) constraints on this element Element id Appointment.participant.actor.identifier
system	S	1..		There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.system
value	S	1..		There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.value

Appointment	I		Appointment	There are no (further) constraints on this element Element id Appointment Short 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) 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). Data type Appointment Constraints app-2: Either start and end are specified, or neither `start.exists() = end.exists()` app-3: Only proposed or cancelled appointments can be missing start/end dates `(start.exists() and end.exists()) or (status in ('proposed' \| 'cancelled' \| 'waitlist'))` app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show `Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')` dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act workflow: Request rim: Act[@moodCode <= 'INT'] ical: VEVENT
id	Σ	0..1	string	There are no (further) constraints on this element Element id Appointment.id Short description 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. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Appointment.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Appointment.implicitRules Short description 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Appointment.language Short description 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text	S	0..1	Narrative	There are no (further) constraints on this element Element id Appointment.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can 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. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Appointment.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. 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 can 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element id Appointment.identifier Short description 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). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.identifier w5: FiveWs.identifier v2: SCH-1, SCH-2, ARQ-1, ARQ-2 rim: .id ical: UID
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id Appointment.status Short description 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. 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. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. Data type code Binding The free/busy status of an appointment. AppointmentStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.status w5: FiveWs.status v2: SCH-25 rim: .statusCode ical: STATUS
cancelationReason	Σ	0..1	CodeableConcept	There are no (further) constraints on this element Element id Appointment.cancelationReason Short description 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. Data type CodeableConcept Binding AppointmentCancellationReason (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
serviceCategory	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id Appointment.serviceCategory Short description 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. Data type CodeableConcept Binding ServiceCategory (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a, might be inferred from the ServiceDeliveryLocation ical: CATEGORIES
serviceType	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element id Appointment.serviceType Short description The specific service that is to be performed during this appointment Definition The specific service that is to be performed during this appointment. Comments 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. Data type CodeableConcept Binding ServiceType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.code rim: n/a, might be inferred from the ServiceDeliveryLocation
specialty	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Appointment.specialty Short description 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. Data type CodeableConcept Binding PracticeSettingCodeValueSet (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.class rim: .performer.AssignedPerson.code
appointmentType	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Appointment.appointmentType Short description 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). Data type CodeableConcept Binding v2.0276 (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: ARQ-7 rim: .code ical: CLASSIFICATION
reasonCode	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Appointment.reasonCode Short description Coded reason this appointment is scheduled Definition The coded reason that this appointment is being scheduled. This is more clinical than administrative. Data type CodeableConcept Binding The Reason for the appointment to take place. EncounterReasonCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.reasonCode v2: AIS-3, SCH-7 rim: .reasonCode
reasonReference		0..*	Reference(Condition \| Procedure \| Observation \| ImmunizationRecommendation)	There are no (further) constraints on this element Element id Appointment.reasonReference Short description Reason the appointment is to take place (resource) Definition Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. Data type Reference(Condition \| Procedure \| Observation \| ImmunizationRecommendation) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.reasonReference rim: .inboundRelationship[@typeCode = 'RSON'].observation
priority		0..1	unsignedInt	There are no (further) constraints on this element Element id Appointment.priority Short description 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. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon. Data type unsignedInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.priority w5: FiveWs.class v2: ARQ-12, SCH-11.6 / TQ1-9 rim: .priorityCode ical: PRIORITY
description	S	0..1	string	There are no (further) constraints on this element Element id Appointment.description Short description 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: NTE-3 rim: .text ical: SUMMARY
supportingInformation		0..*	Reference(Resource)	There are no (further) constraints on this element Element id Appointment.supportingInformation Short description Additional information to support the appointment Definition Additional information to support the appointment provided when making the appointment. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.supportingInfo w5: FiveWs.context rim: .inboundRelationship[@typeCode = 'SPRT'].observation ical: ATTACH
start	S Σ	0..1	instant	There are no (further) constraints on this element Element id Appointment.start Short description When appointment is to take place Definition Date/Time that the appointment is to take place. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.occurrence[x] w5: FiveWs.init v2: ARQ-11.1, SCH-11.4 / TQ1-7 rim: .effectiveTime.low ical: DTSTART
end	Σ	0..1	instant	Element id Appointment.end Short description When appointment is to conclude Definition Date/Time that the appointment is to conclude. Comments 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.occurrence[x] w5: FiveWs.done[x] v2: SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9 rim: .effectiveTime.high ical: DTEND
minutesDuration		0..1	positiveInt	Element id Appointment.minutesDuration Short description 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. Comments 𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.occurrence[x] rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width ical: DURATION (e.g. PT15M)
slot		0..*	Reference(Slot)	There are no (further) constraints on this element Element id Appointment.slot Short description The slots that this appointment is filling Definition The slots from the participants' schedules that will be filled by the appointment. Data type Reference(Slot) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']
created	S	0..1	dateTime	There are no (further) constraints on this element Element id Appointment.created Short description 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. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.authoredOn rim: .author.time ical: CREATED
comment	S	0..1	string	There are no (further) constraints on this element Element id Appointment.comment Short description 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" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.note v2: NTE-3 rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value ical: DESCRIPTION (for internal use)
patientInstruction		0..1	string	Element id Appointment.patientInstruction Short description Detailed information and instructions for the patient Definition While Appointment.comment 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). Comments If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: NTE-3 rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value ical: DESCRIPTION (for patient use)
basedOn	S	1..1	Reference(ServiceRequest)	Element id Appointment.basedOn Short description The service request this appointment is allocated to assess Alternate names incomingReferral Definition The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). Data type Reference(ServiceRequest) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.basedOn rim: .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']
id		0..1	string	There are no (further) constraints on this element Element id Appointment.basedOn.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.basedOn.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
reference	S Σ I	0..1	string	There are no (further) constraints on this element Element id Appointment.basedOn.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id Appointment.basedOn.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	S Σ	0..1	Identifier	There are no (further) constraints on this element Element id Appointment.basedOn.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
id		0..1	string	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	S Σ	1..1	uri	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	S Σ	1..1	string	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Appointment.basedOn.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element id Appointment.basedOn.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
participant	S I	1..*	BackboneElement	There are no (further) constraints on this element Element id Appointment.participant Short description Participants involved in appointment Definition List of participants involved in the appointment. Data type BackboneElement Constraints app-1: Either the type or actor on the participant SHALL be specified `type.exists() or actor.exists()` ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.performer, Request.subject v2: PID, AIP, AIG, AIL rim: performer \| reusableDevice \| subject \| location ical: ATTENDEE component to be created
id		0..1	string	There are no (further) constraints on this element Element id Appointment.participant.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.participant.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.participant.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
type	S Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Appointment.participant.type Short description 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. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. Data type CodeableConcept Binding Role of participant in encounter. ParticipantType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: AIP-4, AIG-4 rim: (performer \| reusableDevice \| subject \| location).@typeCode ical: n/a
actor	S Σ	0..1	Reference(Patient \| PractitionerRole \| Location)	Element id Appointment.participant.actor Short description Person, Location/HealthcareService or Device Definition A Person, Location/HealthcareService or Device that is participating in the appointment. Data type Reference(Patient \| PractitionerRole \| Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.who v2: PID-3-Patient ID List \| AIL-3 \| AIG-3 \| AIP-3 rim: performer.person \| reusableDevice.manufacturedDevice \| subject.patient \| location.serviceDeliveryLocation ical: 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		0..1	string	There are no (further) constraints on this element Element id Appointment.participant.actor.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.participant.actor.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
reference	S Σ I	0..1	string	There are no (further) constraints on this element Element id Appointment.participant.actor.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id Appointment.participant.actor.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	S Σ	0..1	Identifier	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
id		0..1	string	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.5 rim: Role.code or implied by context
system	S Σ	1..1	uri	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	S Σ	1..1	string	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id Appointment.participant.actor.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element id Appointment.participant.actor.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
required	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id Appointment.participant.required Short description required \| optional \| information-only Definition Whether this participant is required to be present at the meeting. This covers a 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. Data type code Binding Is the Participant required to attend the appointment. ParticipantRequired (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: (performer \| reusableDevice \| subject \| location).@performInd ical: ROLE=REQ-PARTICIPANT (roleparam)
status	Σ	1..1	codeBinding	There are no (further) constraints on this element Element id Appointment.participant.status Short description accepted \| declined \| tentative \| needs-action Definition Participation status of the actor. Data type code Binding The Participation status of an appointment. ParticipationStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: AIP-12, AIG-14 rim: (performer \| reusableDevice \| subject \| location).statusCode ical: ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam \| partstatparam)
period		0..1	Period	There are no (further) constraints on this element Element id Appointment.participant.period Short description Participation period of the actor Definition Participation period of the actor. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
requestedPeriod		0..*	Period	There are no (further) constraints on this element Element id Appointment.requestedPeriod Short description 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. The 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. Comments This does not introduce a capacity for recurring appointments. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Request.occurrence[x] v2: ARQ-11 rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="CA-eReC-Appointment" />
    <url value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Appointment" />
    <name value="Appointment" />
    <status value="draft" />
    <description value="The resource involves booking one (or a series) of appointment(s) between the patient and the practitioner(s) for a specific date/time. The encounter may be a scheduled referral or an econsult." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Appointment" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Appointment" />
    <derivation value="constraint" />
    <differential>
        <element id="Appointment.text">
            <path value="Appointment.text" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.status">
            <path value="Appointment.status" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.description">
            <path value="Appointment.description" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.start">
            <path value="Appointment.start" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.end">
            <path value="Appointment.end" />
            <comment value="&#120294;&#120296;&#120291;&#120291;&#120290;&#120293;&#120295;: One of end or minutesDuration must be supported." />
        </element>
        <element id="Appointment.minutesDuration">
            <path value="Appointment.minutesDuration" />
            <comment value="&#120294;&#120296;&#120291;&#120291;&#120290;&#120293;&#120295;: One of end or minutesDuration must be supported." />
        </element>
        <element id="Appointment.created">
            <path value="Appointment.created" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.comment">
            <path value="Appointment.comment" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.patientInstruction">
            <path value="Appointment.patientInstruction" />
            <comment value="If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field." />
        </element>
        <element id="Appointment.basedOn">
            <path value="Appointment.basedOn" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Appointment.basedOn.reference">
            <path value="Appointment.basedOn.reference" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.basedOn.identifier">
            <path value="Appointment.basedOn.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.basedOn.identifier.use">
            <path value="Appointment.basedOn.identifier.use" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.basedOn.identifier.system">
            <path value="Appointment.basedOn.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.basedOn.identifier.value">
            <path value="Appointment.basedOn.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant">
            <path value="Appointment.participant" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.type">
            <path value="Appointment.participant.type" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor">
            <path value="Appointment.participant.actor" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Location" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.reference">
            <path value="Appointment.participant.actor.reference" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.identifier">
            <path value="Appointment.participant.actor.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.identifier.system">
            <path value="Appointment.participant.actor.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Appointment.participant.actor.identifier.value">
            <path value="Appointment.participant.actor.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "CA-eReC-Appointment",
    "url": "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Appointment",
    "name": "Appointment",
    "status": "draft",
    "description": "The resource involves booking one (or a series) of appointment(s) between the patient and the practitioner(s) for a specific date/time. The encounter may be a scheduled referral or an econsult.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Appointment",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Appointment.text",
                "path": "Appointment.text",
                "mustSupport": true
            },
            {
                "id": "Appointment.status",
                "path": "Appointment.status",
                "mustSupport": true
            },
            {
                "id": "Appointment.description",
                "path": "Appointment.description",
                "mustSupport": true
            },
            {
                "id": "Appointment.start",
                "path": "Appointment.start",
                "mustSupport": true
            },
            {
                "id": "Appointment.end",
                "path": "Appointment.end",
                "comment": "𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported."
            },
            {
                "id": "Appointment.minutesDuration",
                "path": "Appointment.minutesDuration",
                "comment": "𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported."
            },
            {
                "id": "Appointment.created",
                "path": "Appointment.created",
                "mustSupport": true
            },
            {
                "id": "Appointment.comment",
                "path": "Appointment.comment",
                "mustSupport": true
            },
            {
                "id": "Appointment.patientInstruction",
                "path": "Appointment.patientInstruction",
                "comment": "If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field."
            },
            {
                "id": "Appointment.basedOn",
                "path": "Appointment.basedOn",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Appointment.basedOn.reference",
                "path": "Appointment.basedOn.reference",
                "mustSupport": true
            },
            {
                "id": "Appointment.basedOn.identifier",
                "path": "Appointment.basedOn.identifier",
                "mustSupport": true
            },
            {
                "id": "Appointment.basedOn.identifier.use",
                "path": "Appointment.basedOn.identifier.use",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.basedOn.identifier.system",
                "path": "Appointment.basedOn.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.basedOn.identifier.value",
                "path": "Appointment.basedOn.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.participant",
                "path": "Appointment.participant",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.type",
                "path": "Appointment.participant.type",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor",
                "path": "Appointment.participant.actor",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient",
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole",
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Location"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.reference",
                "path": "Appointment.participant.actor.reference",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.identifier",
                "path": "Appointment.participant.actor.identifier",
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.identifier.system",
                "path": "Appointment.participant.actor.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Appointment.participant.actor.identifier.value",
                "path": "Appointment.participant.actor.identifier.value",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

Terminology bindings

Constraints

Usage

The Appointment resource is used to represent a meeting planned in response to a ServiceRequest. References to other resources are used to convey the details of the appointment including ServiceRequest the appointment is based on (Appointment.basedOn) and participants (Appointment.participant.actor) in the appointment such as a Patient, PractitionerRole, or HealthcareService. Systems SHALL support start and SHALL support one of end or minutesDuration or both.

Notes

.id

used to uniquely identify the resource
if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

.text

Used to provide human readable human readable that can be pasted into other systems with complete information about the appointment
Where populated:
- .text.div SHALL include a full text summary of the appointment
- .text.status, populate with the fixed code "generated"

.identifier

MAY be populated to share business identifers used to reference this resource in subsequent messages
identifier.system and identifier.value SHALL be mustSupport whenever there is a reference or identifier present

.status

Typically populated with "booked" (or "cancelled" if unbooked)

.description

Title of the appointment (e.g. the Subject on an appointment in MS Outlook)

.start

Populate with the appointment start time
Format: YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z).

.end

𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported
Populate with the appointment end time
Format: YYYY-MM-DDThh:mm:ss.sss+zz:zz (e.g. 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z).

.minutesDuration

𝗦𝗨𝗣𝗣𝗢𝗥𝗧: One of end or minutesDuration must be supported
Duration of appointment in minutes
Populate with a positive integer

.created

Populate with the date that this appointment was initially created (NOT the time of the appointment itself)

.comment

Additional comments and details about the appointment (i.e. the Body of an appointment in MS Outlook)

.patientInstruction

Detailed information and instructions for the patient
If systems are capturing instructions to a patient independently from other comments, they SHOULD use the patientInstruction field.

.basedOn

used to associate the Appointment with the ServiceRequest being performed
SHALL be populated with a reference to the ServiceRequest being performed
if the Appointment is being transmitted via messaging, this element SHALL be populated with either:
- a .reference to a resource included in the message as a Bundle.entry, or
- an .identifier populated with the use, system and value elements populated with the official ServiceRequest.identifier received from the Source System

.participant

Repeating element identifies one or more participants in the appointment where
- .participant.type is a value from ParticipantType(extensible)
- .participant.actor a reference to one of:
  - the Patient being seen > SHALL be the same as the ServiceRequest.subject
  - the PractitionerRole seeing the patient
  - the Location of the appointment
- .participant.status is expected to be "accepted" for a booked appointment

Note: If an Appointment is being transmitted via messaging, referenced Patient, PractitionerRole and Location resources SHALL .reference the resource to included in the message as a Bundle.entry