StructureDefinition UKCore-Appointment

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
bookingOrganizationC0..1Extension(Reference(Organization))
deliveryChannelC0..1Extension(CodeableConcept)
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBinding
cancelationReasonΣ0..1CodeableConcept
serviceCategoryΣ0..*CodeableConcept
serviceTypeΣ0..*CodeableConceptBinding
specialtyS Σ0..*CodeableConceptBinding
appointmentTypeS Σ0..1CodeableConceptBinding
reasonCodeS Σ0..*CodeableConceptBinding
reasonReferenceS C0..*Reference(Condition | ImmunizationRecommendation | Observation | Procedure)
priority0..1unsignedInt
description0..1string
supportingInformationC0..*Reference(Resource)
startS Σ0..1instant
endΣ0..1instant
minutesDuration0..1positiveInt
slotC0..*Reference(Slot)
created0..1dateTime
comment0..1string
patientInstruction0..1string
basedOnS C0..*Reference(ServiceRequest)
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
typeΣ0..*CodeableConceptBinding
actorΣ C0..1Reference(Device | HealthcareService | Location | Patient | Practitioner | PractitionerRole | RelatedPerson)
requiredΣ0..1codeBinding
statusΣ1..1codeBinding
periodC0..1Period
requestedPeriodC0..*Period
AppointmentC
ShortA 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).

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • 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')
  • 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-2: Either start and end are specified, or neither
    start.exists() = end.exists()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Request
  • rim: Act[@moodCode <= 'INT']
  • ical: VEVENT
Appointment.idΣ
ShortLogical 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.

Cardinality0..1
Typeid
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.metaΣ
ShortMetadata 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.

Cardinality0..1
TypeMeta
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Appointment.implicitRulesΣ ?!
ShortA 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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
MaxValueSetAllLanguages
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).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Appointment.text
ShortText summary of the resource, for human interpretation
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.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Appointment.contained
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
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.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
Appointment.extensionC
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
  • rim: N/A
Appointment.extension:bookingOrganizationC
ShortA reference to the source Organization of the booked appointment.
Definition

An extension to record the organisation booking the appointment.

Cardinality0..1
TypeExtension(Reference(Organization))
Aliasextensions, user content
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
  • rim: N/A
Appointment.extension:deliveryChannelC
ShortDefines the delivery channel of a scheduled appointment.
Definition

An extension to record the delivery channel of a scheduled Appointment.

Cardinality0..1
TypeExtension(CodeableConcept)
Aliasextensions, user content
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
  • rim: N/A
Appointment.modifierExtension?! C
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
  • rim: N/A
Appointment.identifierΣ
ShortExternal 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).

Cardinality0..*
TypeIdentifier
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Request.identifier
  • w5: FiveWs.identifier
  • v2: SCH-1, SCH-2, ARQ-1, ARQ-2
  • rim: .id
  • ical: UID
Appointment.statusS Σ ?!
ShortThe overall status of the appointment.
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.

Cardinality1..1
Typecode
Binding

The free/busy status of an appointment.

AppointmentStatus (required)

Must SupportTrue
ModifierTrue
SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.status
  • w5: FiveWs.status
  • v2: SCH-25
  • rim: .statusCode
  • ical: STATUS
Appointment.cancelationReasonΣ
ShortThe 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.

Cardinality0..1
TypeCodeableConcept
Binding

AppointmentCancellationReason (example)

SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
Appointment.serviceCategoryΣ
ShortA 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.

Cardinality0..*
TypeCodeableConcept
Binding

ServiceCategory (example)

SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: n/a, might be inferred from the ServiceDeliveryLocation
  • ical: CATEGORIES
Appointment.serviceTypeΣ
ShortThe specific service that is to be performed during this appointment
Definition

The specific service that is to be performed during this appointment.

Cardinality0..*
TypeCodeableConcept
Binding

Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102.

UKCoreCareSettingType (preferred)

SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Request.code
  • rim: n/a, might be inferred from the ServiceDeliveryLocation
Appointment.specialtyS Σ
ShortThe 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.

Cardinality0..*
TypeCodeableConcept
Binding

UKCorePracticeSettingCode (extensible)

Must SupportTrue
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • rim: .performer.AssignedPerson.code
Appointment.appointmentTypeS Σ
ShortThe type of appointment or patient that has been booked in the slot.
Definition

The style of appointment or patient that has been booked in the slot (not service type).

Cardinality0..1
TypeCodeableConcept
Binding

A set of codes that define an appointment reason.

UKCoreAppointmentReasonCode (extensible)

Must SupportTrue
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: ARQ-7
  • rim: .code
  • ical: CLASSIFICATION
Appointment.reasonCodeS Σ
ShortThe reason for the appointment.
Definition

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

Cardinality0..*
TypeCodeableConcept
Binding

The Reason for the appointment to take place.

EncounterReasonCodes (preferred)

Must SupportTrue
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Request.reasonCode
  • v2: AIS-3, SCH-7
  • rim: .reasonCode
Appointment.reasonReferenceS C
ShortA reference to the Observation, Condition, Procedure, or ImmunizationRecommendation that is the reason for the appointment.
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.

Cardinality0..*
TypeReference(Condition | ImmunizationRecommendation | Observation | Procedure)
Must SupportTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.reasonReference
  • rim: .inboundRelationship[@typeCode = 'RSON'].observation
Appointment.priority
ShortUsed 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).

Cardinality0..1
TypeunsignedInt
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.priority
  • w5: FiveWs.class
  • v2: ARQ-12, SCH-11.6 / TQ1-9
  • rim: .priorityCode
  • ical: PRIORITY
Appointment.description
ShortShown 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.

Cardinality0..1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NTE-3
  • rim: .text
  • ical: SUMMARY
Appointment.supportingInformationC
ShortAdditional information to support the appointment
Definition

Additional information to support the appointment provided when making the appointment.

Cardinality0..*
TypeReference(Resource)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.supportingInfo
  • w5: FiveWs.context
  • rim: .inboundRelationship[@typeCode = 'SPRT'].observation
  • ical: ATTACH
Appointment.startS Σ
ShortThe start time of the appointment.
Definition

Date/Time that the appointment is to take place.

Cardinality0..1
Typeinstant
Must SupportTrue
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.occurrence[x]
  • w5: FiveWs.init
  • v2: ARQ-11.1, SCH-11.4 / TQ1-7
  • rim: .effectiveTime.low
  • ical: DTSTART
Appointment.endΣ
ShortWhen appointment is to conclude
Definition

Date/Time that the appointment is to conclude.

Cardinality0..1
Typeinstant
SummaryTrue
Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • 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
Appointment.minutesDuration
ShortCan 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.

Cardinality0..1
TypepositiveInt
Comments

32 bit number; for values larger than this, use decimal

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.occurrence[x]
  • rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
  • ical: DURATION (e.g. PT15M)
Appointment.slotC
ShortThe slots that this appointment is filling
Definition

The slots from the participants' schedules that will be filled by the appointment.

Cardinality0..*
TypeReference(Slot)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']
Appointment.created
ShortThe 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.

Cardinality0..1
TypedateTime
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.authoredOn
  • rim: .author.time
  • ical: CREATED
Appointment.comment
ShortAdditional comments
Definition

Additional comments about the appointment.

Cardinality0..1
Typestring
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Request.note
  • v2: NTE-3
  • rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
  • ical: DESCRIPTION (for internal use)
Appointment.patientInstruction
ShortDetailed 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).

Cardinality0..1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: NTE-3
  • rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
  • ical: DESCRIPTION (for patient use)
Appointment.basedOnS C
ShortThe 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).

Cardinality0..*
TypeReference(ServiceRequest)
Must SupportTrue
AliasincomingReferral
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Request.basedOn
  • rim: .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']
Appointment.participantS C
ShortA list of participants involved in the appointment.
Definition

List of participants involved in the appointment.

Cardinality1..*
TypeBackboneElement
Must SupportTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • app-1: Either the type or actor on the participant SHALL be specified
    type.exists() or actor.exists()
Mappings
  • rim: n/a
  • workflow: Request.performer, Request.subject
  • v2: PID, AIP, AIG, AIL
  • rim: performer | reusableDevice | subject | location
  • ical: ATTENDEE component to be created
Appointment.participant.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Appointment.participant.extensionC
ShortAdditional content defined by implementations
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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
  • rim: N/A
Appointment.participant.modifierExtensionΣ ?! C
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
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
  • rim: N/A
Appointment.participant.typeΣ
ShortRole of participant in the appointment
Definition

Role of participant in the appointment.

Cardinality0..*
TypeCodeableConcept
Binding

Role of participant in encounter.

ParticipantType (extensible)

SummaryTrue
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: AIP-4, AIG-4
  • rim: (performer | reusableDevice | subject | location).@typeCode
  • ical: n/a
Appointment.participant.actorΣ C
ShortPerson, Location/HealthcareService or Device
Definition

A Person, Location/HealthcareService or Device that is participating in the appointment.

Cardinality0..1
TypeReference(Device | HealthcareService | Location | Patient | Practitioner | PractitionerRole | RelatedPerson)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • 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"
Appointment.participant.requiredΣ
Shortrequired | 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.

Cardinality0..1
Typecode
Binding

Is the Participant required to attend the appointment.

ParticipantRequired (required)

SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: (performer | reusableDevice | subject | location).@performInd
  • ical: ROLE=REQ-PARTICIPANT (roleparam)
Appointment.participant.statusΣ
Shortaccepted | declined | tentative | needs-action
Definition

Participation status of the actor.

Cardinality1..1
Typecode
Binding

The Participation status of an appointment.

ParticipationStatus (required)

SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: AIP-12, AIG-14
  • rim: (performer | reusableDevice | subject | location).statusCode
  • ical: ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
Appointment.participant.periodC
ShortParticipation period of the actor
Definition

Participation period of the actor.

Cardinality0..1
TypePeriod
Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
Appointment.requestedPeriodC
ShortPotential 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.

Cardinality0..*
TypePeriod
Comments

This does not introduce a capacity for recurring appointments.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • workflow: Request.occurrence[x]
  • v2: ARQ-11
  • rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]
Appointment0..*
Appointment.idid0..1
Appointment.metaMeta0..1
Appointment.implicitRulesuri0..1
Appointment.languagecode0..1
Appointment.textNarrative0..1
Appointment.containedResource0..*
Appointment.extensionExtension0..*
Appointment.extension:bookingOrganizationExtension0..1
Appointment.extension:deliveryChannelExtension0..1
Appointment.modifierExtensionExtension0..*
Appointment.identifierIdentifier0..*
Appointment.statuscode1..1
Appointment.cancelationReasonCodeableConcept0..1
Appointment.serviceCategoryCodeableConcept0..*
Appointment.serviceTypeCodeableConcept0..*
Appointment.specialtyCodeableConcept0..*
Appointment.appointmentTypeCodeableConcept0..1
Appointment.reasonCodeCodeableConcept0..*
Appointment.reasonReferenceReference(Condition | ImmunizationRecommendation | Observation | Procedure)0..*
Appointment.priorityunsignedInt0..1
Appointment.descriptionstring0..1
Appointment.supportingInformationReference(Resource)0..*
Appointment.startinstant0..1
Appointment.endinstant0..1
Appointment.minutesDurationpositiveInt0..1
Appointment.slotReference(Slot)0..*
Appointment.createddateTime0..1
Appointment.commentstring0..1
Appointment.patientInstructionstring0..1
Appointment.basedOnReference(ServiceRequest)0..*
Appointment.participantBackboneElement1..*
Appointment.participant.idstring0..1
Appointment.participant.extensionExtension0..*
Appointment.participant.modifierExtensionExtension0..*
Appointment.participant.typeCodeableConcept0..*
Appointment.participant.actorReference(Device | HealthcareService | Location | Patient | Practitioner | PractitionerRole | RelatedPerson)0..1
Appointment.participant.requiredcode0..1
Appointment.participant.statuscode1..1
Appointment.participant.periodPeriod0..1
Appointment.requestedPeriodPeriod0..*

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="UKCore-Appointment" />
<url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment" />
<version value="1.4.0" />
<name value="UKCoreAppointment" />
<title value="UK Core Appointment" />
<status value="active" />
<date value="2026-01-19" />
<publisher value="HL7 UK" />
<name value="HL7 UK" />
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="This profile defines the UK constraints and extensions on the International FHIR resource [Appointment](https://hl7.org/fhir/R4/Appointment.html)." />
<purpose value="This profile allows recording of detailed information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources to be created for each instance. \n\n Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.) All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time." />
<copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." />
<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" />
<element id="Appointment">
<path value="Appointment" />
<short value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)" />
<definition value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)." />
<min value="0" />
<max value="*" />
<path value="Appointment" />
<min value="0" />
<max value="*" />
</base>
<key value="dom-2" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
<expression value="contained.contained.empty()" />
<xpath value="not(parent::f:contained and f:contained)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="dom-4" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="dom-3" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource" />
<expression value="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()" />
<xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." />
</extension>
<key value="dom-6" />
<severity value="warning" />
<human value="A resource should have narrative for robust management" />
<expression value="text.`div`.exists()" />
<xpath value="exists(f:text/h:div)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="dom-5" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
<expression value="contained.meta.security.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:security))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<key value="app-4" />
<severity value="error" />
<human value="Cancelation reason is only used for appointments that have been cancelled, or no-show" />
<expression value="Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')" />
<xpath value="not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')" />
<source value="http://hl7.org/fhir/StructureDefinition/Appointment" />
</constraint>
<key value="app-3" />
<severity value="error" />
<human value="Only proposed or cancelled appointments can be missing start/end dates" />
<expression value="(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))" />
<xpath value="((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))" />
<source value="http://hl7.org/fhir/StructureDefinition/Appointment" />
</constraint>
<key value="app-2" />
<severity value="error" />
<human value="Either start and end are specified, or neither" />
<expression value="start.exists() = end.exists()" />
<xpath value="((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))" />
<source value="http://hl7.org/fhir/StructureDefinition/Appointment" />
</constraint>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<identity value="workflow" />
<map value="Request" />
</mapping>
<identity value="rim" />
<map value="Act[@moodCode <= 'INT']" />
</mapping>
<identity value="ical" />
<map value="VEVENT" />
</mapping>
</element>
<element id="Appointment.id">
<path value="Appointment.id" />
<short value="Logical id of this artifact" />
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
<min value="0" />
<max value="1" />
<path value="Resource.id" />
<min value="0" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id" />
</extension>
<code value="id" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Appointment.meta">
<path value="Appointment.meta" />
<short value="Metadata about the resource" />
<definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." />
<min value="0" />
<max value="1" />
<path value="Resource.meta" />
<min value="0" />
<max value="1" />
</base>
<code value="Meta" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.implicitRules">
<path value="Appointment.implicitRules" />
<short value="A set of rules under which this content was created" />
<definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." />
<comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. 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." />
<min value="0" />
<max value="1" />
<path value="Resource.implicitRules" />
<min value="0" />
<max value="1" />
</base>
<code value="uri" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Appointment.language">
<path value="Appointment.language" />
<short value="Language of the resource content" />
<definition value="The base language in which the resource is written." />
<comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." />
<min value="0" />
<max value="1" />
<path value="Resource.language" />
<min value="0" />
<max value="1" />
</base>
<code value="code" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language" />
</extension>
<strength value="preferred" />
<description value="A human language." />
<valueSet value="http://hl7.org/fhir/ValueSet/languages" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Appointment.text">
<path value="Appointment.text" />
<short value="Text summary of the resource, for human interpretation" />
<definition value="A human-readable narrative that contains a summary of the resource and 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." />
<comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." />
<alias value="narrative" />
<alias value="html" />
<alias value="xhtml" />
<alias value="display" />
<min value="0" />
<max value="1" />
<path value="DomainResource.text" />
<min value="0" />
<max value="1" />
</base>
<code value="Narrative" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
<identity value="rim" />
<map value="Act.text?" />
</mapping>
</element>
<element id="Appointment.contained">
<path value="Appointment.contained" />
<short value="Contained, inline Resources" />
<definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." />
<comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." />
<alias value="inline resources" />
<alias value="anonymous resources" />
<alias value="contained resources" />
<min value="0" />
<max value="*" />
<path value="DomainResource.contained" />
<min value="0" />
<max value="*" />
</base>
<code value="Resource" />
</type>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.extension">
<path value="Appointment.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource. 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." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.extension:bookingOrganization">
<path value="Appointment.extension" />
<sliceName value="bookingOrganization" />
<short value="A reference to the source Organization of the booked appointment." />
<definition value="An extension to record the organisation booking the appointment." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="1" />
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.extension:deliveryChannel">
<path value="Appointment.extension" />
<sliceName value="deliveryChannel" />
<short value="Defines the delivery channel of a scheduled appointment." />
<definition value="An extension to record the delivery channel of a scheduled Appointment." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="1" />
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.modifierExtension">
<path value="Appointment.modifierExtension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Extensions that cannot be ignored" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="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](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="DomainResource.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.identifier">
<path value="Appointment.identifier" />
<short value="External Ids for this item" />
<definition value="This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)." />
<min value="0" />
<max value="*" />
<path value="Appointment.identifier" />
<min value="0" />
<max value="*" />
</base>
<code value="Identifier" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" />
</mapping>
<identity value="rim" />
<map value="II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]" />
</mapping>
<identity value="servd" />
<map value="Identifier" />
</mapping>
<identity value="workflow" />
<map value="Request.identifier" />
</mapping>
<identity value="w5" />
<map value="FiveWs.identifier" />
</mapping>
<identity value="v2" />
<map value="SCH-1, SCH-2, ARQ-1, ARQ-2" />
</mapping>
<identity value="rim" />
<map value=".id" />
</mapping>
<identity value="ical" />
<map value="UID" />
</mapping>
</element>
<element id="Appointment.status">
<path value="Appointment.status" />
<short value="The overall status of the appointment." />
<definition value="The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status." />
<comment value="If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\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 value="1" />
<max value="1" />
<path value="Appointment.status" />
<min value="1" />
<max value="1" />
</base>
<code value="code" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isModifier value="true" />
<isModifierReason value="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 value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="AppointmentStatus" />
</extension>
<strength value="required" />
<description value="The free/busy status of an appointment." />
<valueSet value="http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.status" />
</mapping>
<identity value="w5" />
<map value="FiveWs.status" />
</mapping>
<identity value="v2" />
<map value="SCH-25" />
</mapping>
<identity value="rim" />
<map value=".statusCode" />
</mapping>
<identity value="ical" />
<map value="STATUS" />
</mapping>
</element>
<element id="Appointment.cancelationReason">
<path value="Appointment.cancelationReason" />
<short value="The coded reason for the appointment being cancelled" />
<definition value="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." />
<comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." />
<min value="0" />
<max value="1" />
<path value="Appointment.cancelationReason" />
<min value="0" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="cancelation-reason" />
</extension>
<strength value="example" />
<valueSet value="http://hl7.org/fhir/ValueSet/appointment-cancellation-reason" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
</element>
<element id="Appointment.serviceCategory">
<path value="Appointment.serviceCategory" />
<short value="A broad categorization of the service that is to be performed during this appointment" />
<definition value="A broad categorization of the service that is to be performed during this appointment." />
<comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." />
<min value="0" />
<max value="*" />
<path value="Appointment.serviceCategory" />
<min value="0" />
<max value="*" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="service-category" />
</extension>
<strength value="example" />
<valueSet value="http://hl7.org/fhir/ValueSet/service-category" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="rim" />
<map value="n/a, might be inferred from the ServiceDeliveryLocation" />
</mapping>
<identity value="ical" />
<map value="CATEGORIES" />
</mapping>
</element>
<element id="Appointment.serviceType">
<path value="Appointment.serviceType" />
<short value="The specific service that is to be performed during this appointment" />
<definition value="The specific service that is to be performed during this appointment." />
<comment value="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 value="0" />
<max value="*" />
<path value="Appointment.serviceType" />
<min value="0" />
<max value="*" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="service-type" />
</extension>
<strength value="preferred" />
<description value="Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102." />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="workflow" />
<map value="Request.code" />
</mapping>
<identity value="rim" />
<map value="n/a, might be inferred from the ServiceDeliveryLocation" />
</mapping>
</element>
<element id="Appointment.specialty">
<path value="Appointment.specialty" />
<short value="The specialty of a practitioner that would be required to perform the service requested in this appointment." />
<definition value="The specialty of a practitioner that would be required to perform the service requested in this appointment." />
<comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." />
<min value="0" />
<max value="*" />
<path value="Appointment.specialty" />
<min value="0" />
<max value="*" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="specialty" />
</extension>
<strength value="extensible" />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="w5" />
<map value="FiveWs.class" />
</mapping>
<identity value="rim" />
<map value=".performer.AssignedPerson.code" />
</mapping>
</element>
<element id="Appointment.appointmentType">
<path value="Appointment.appointmentType" />
<short value="The type of appointment or patient that has been booked in the slot." />
<definition value="The style of appointment or patient that has been booked in the slot (not service type)." />
<comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." />
<min value="0" />
<max value="1" />
<path value="Appointment.appointmentType" />
<min value="0" />
<max value="1" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="appointment-type" />
</extension>
<strength value="extensible" />
<description value="A set of codes that define an appointment reason." />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AppointmentReasonCode" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="v2" />
<map value="ARQ-7" />
</mapping>
<identity value="rim" />
<map value=".code" />
</mapping>
<identity value="ical" />
<map value="CLASSIFICATION" />
</mapping>
</element>
<element id="Appointment.reasonCode">
<path value="Appointment.reasonCode" />
<short value="The reason for the appointment." />
<definition value="The coded reason that this appointment is being scheduled. This is more clinical than administrative." />
<comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." />
<min value="0" />
<max value="*" />
<path value="Appointment.reasonCode" />
<min value="0" />
<max value="*" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ApptReason" />
</extension>
<strength value="preferred" />
<description value="The Reason for the appointment to take place." />
<valueSet value="http://hl7.org/fhir/ValueSet/encounter-reason" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="workflow" />
<map value="Request.reasonCode" />
</mapping>
<identity value="v2" />
<map value="AIS-3, SCH-7" />
</mapping>
<identity value="rim" />
<map value=".reasonCode" />
</mapping>
</element>
<element id="Appointment.reasonReference">
<path value="Appointment.reasonReference" />
<short value="A reference to the Observation, Condition, Procedure, or ImmunizationRecommendation that is the reason for the appointment." />
<definition value="Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="0" />
<max value="*" />
<path value="Appointment.reasonReference" />
<min value="0" />
<max value="*" />
</base>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Procedure" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mustSupport value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<identity value="workflow" />
<map value="Request.reasonReference" />
</mapping>
<identity value="rim" />
<map value=".inboundRelationship[@typeCode = 'RSON'].observation" />
</mapping>
</element>
<element id="Appointment.priority">
<path value="Appointment.priority" />
<short value="Used to make informed decisions if needing to re-prioritize" />
<definition value="The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)." />
<comment value="Seeking implementer feedback on this property and how interoperable it is.\n\nUsing an extension to record a CodeableConcept for named values may be tested at a future connectathon." />
<min value="0" />
<max value="1" />
<path value="Appointment.priority" />
<min value="0" />
<max value="1" />
</base>
<code value="unsignedInt" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.priority" />
</mapping>
<identity value="w5" />
<map value="FiveWs.class" />
</mapping>
<identity value="v2" />
<map value="ARQ-12, SCH-11.6 / TQ1-9" />
</mapping>
<identity value="rim" />
<map value=".priorityCode" />
</mapping>
<identity value="ical" />
<map value="PRIORITY" />
</mapping>
</element>
<element id="Appointment.description">
<path value="Appointment.description" />
<short value="Shown on a subject line in a meeting request, or appointment list" />
<definition value="The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<min value="0" />
<max value="1" />
<path value="Appointment.description" />
<min value="0" />
<max value="1" />
</base>
<code value="string" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="NTE-3" />
</mapping>
<identity value="rim" />
<map value=".text" />
</mapping>
<identity value="ical" />
<map value="SUMMARY" />
</mapping>
</element>
<element id="Appointment.supportingInformation">
<path value="Appointment.supportingInformation" />
<short value="Additional information to support the appointment" />
<definition value="Additional information to support the appointment provided when making the appointment." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="0" />
<max value="*" />
<path value="Appointment.supportingInformation" />
<min value="0" />
<max value="*" />
</base>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<identity value="workflow" />
<map value="Request.supportingInfo" />
</mapping>
<identity value="w5" />
<map value="FiveWs.context" />
</mapping>
<identity value="rim" />
<map value=".inboundRelationship[@typeCode = 'SPRT'].observation" />
</mapping>
<identity value="ical" />
<map value="ATTACH" />
</mapping>
</element>
<element id="Appointment.start">
<path value="Appointment.start" />
<short value="The start time of the appointment." />
<definition value="Date/Time that the appointment is to take place." />
<comment value="Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required" />
<min value="0" />
<max value="1" />
<path value="Appointment.start" />
<min value="0" />
<max value="1" />
</base>
<code value="instant" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.occurrence[x]" />
</mapping>
<identity value="w5" />
<map value="FiveWs.init" />
</mapping>
<identity value="v2" />
<map value="ARQ-11.1, SCH-11.4 / TQ1-7" />
</mapping>
<identity value="rim" />
<map value=".effectiveTime.low" />
</mapping>
<identity value="ical" />
<map value="DTSTART" />
</mapping>
</element>
<element id="Appointment.end">
<path value="Appointment.end" />
<short value="When appointment is to conclude" />
<definition value="Date/Time that the appointment is to conclude." />
<comment value="Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required" />
<min value="0" />
<max value="1" />
<path value="Appointment.end" />
<min value="0" />
<max value="1" />
</base>
<code value="instant" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.occurrence[x]" />
</mapping>
<identity value="w5" />
<map value="FiveWs.done[x]" />
</mapping>
<identity value="v2" />
<map value="SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9" />
</mapping>
<identity value="rim" />
<map value=".effectiveTime.high" />
</mapping>
<identity value="ical" />
<map value="DTEND" />
</mapping>
</element>
<element id="Appointment.minutesDuration">
<path value="Appointment.minutesDuration" />
<short value="Can be less than start/end (e.g. estimate)" />
<definition value="Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. 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." />
<comment value="32 bit number; for values larger than this, use decimal" />
<min value="0" />
<max value="1" />
<path value="Appointment.minutesDuration" />
<min value="0" />
<max value="1" />
</base>
<code value="positiveInt" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.occurrence[x]" />
</mapping>
<identity value="rim" />
<map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width" />
</mapping>
<identity value="ical" />
<map value="DURATION (e.g. PT15M)" />
</mapping>
</element>
<element id="Appointment.slot">
<path value="Appointment.slot" />
<short value="The slots that this appointment is filling" />
<definition value="The slots from the participants' schedules that will be filled by the appointment." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="0" />
<max value="*" />
<path value="Appointment.slot" />
<min value="0" />
<max value="*" />
</base>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Slot" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<identity value="rim" />
<map value=".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']" />
</mapping>
</element>
<element id="Appointment.created">
<path value="Appointment.created" />
<short value="The date that this appointment was initially created" />
<definition value="The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment." />
<comment value="This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments." />
<min value="0" />
<max value="1" />
<path value="Appointment.created" />
<min value="0" />
<max value="1" />
</base>
<code value="dateTime" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.authoredOn" />
</mapping>
<identity value="rim" />
<map value=".author.time" />
</mapping>
<identity value="ical" />
<map value="CREATED" />
</mapping>
</element>
<element id="Appointment.comment">
<path value="Appointment.comment" />
<short value="Additional comments" />
<definition value="Additional comments about the appointment." />
<comment value="Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival"\n\nWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it." />
<min value="0" />
<max value="1" />
<path value="Appointment.comment" />
<min value="0" />
<max value="1" />
</base>
<code value="string" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.note" />
</mapping>
<identity value="v2" />
<map value="NTE-3" />
</mapping>
<identity value="rim" />
<map value=".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" />
</mapping>
<identity value="ical" />
<map value="DESCRIPTION (for internal use)" />
</mapping>
</element>
<element id="Appointment.patientInstruction">
<path value="Appointment.patientInstruction" />
<short value="Detailed information and instructions for the patient" />
<definition value="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)." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<min value="0" />
<max value="1" />
<path value="Appointment.patientInstruction" />
<min value="0" />
<max value="1" />
</base>
<code value="string" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="NTE-3" />
</mapping>
<identity value="rim" />
<map value=".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" />
</mapping>
<identity value="ical" />
<map value="DESCRIPTION (for patient use)" />
</mapping>
</element>
<element id="Appointment.basedOn">
<path value="Appointment.basedOn" />
<short value="The service request this appointment is allocated to assess." />
<definition value="The service request this appointment is allocated to assess (e.g. incoming referral or procedure request)." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<alias value="incomingReferral" />
<min value="0" />
<max value="*" />
<path value="Appointment.basedOn" />
<min value="0" />
<max value="*" />
</base>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mustSupport value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<identity value="workflow" />
<map value="Request.basedOn" />
</mapping>
<identity value="rim" />
<map value=".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']" />
</mapping>
</element>
<element id="Appointment.participant">
<path value="Appointment.participant" />
<short value="A list of participants involved in the appointment." />
<definition value="List of participants involved in the appointment." />
<min value="1" />
<max value="*" />
<path value="Appointment.participant" />
<min value="1" />
<max value="*" />
</base>
<code value="BackboneElement" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="app-1" />
<severity value="error" />
<human value="Either the type or actor on the participant SHALL be specified" />
<expression value="type.exists() or actor.exists()" />
<xpath value="(exists(f:type) or exists(f:actor))" />
<source value="http://hl7.org/fhir/StructureDefinition/Appointment" />
</constraint>
<mustSupport value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="workflow" />
<map value="Request.performer, Request.subject" />
</mapping>
<identity value="v2" />
<map value="PID, AIP, AIG, AIL" />
</mapping>
<identity value="rim" />
<map value="performer | reusableDevice | subject | location" />
</mapping>
<identity value="ical" />
<map value="ATTENDEE component to be created" />
</mapping>
</element>
<element id="Appointment.participant.id">
<path value="Appointment.participant.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Appointment.participant.extension">
<path value="Appointment.participant.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. 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." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.participant.modifierExtension">
<path value="Appointment.participant.modifierExtension" />
<short value="Extensions that cannot be ignored even if unrecognized" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="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](extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<alias value="modifiers" />
<min value="0" />
<max value="*" />
<path value="BackboneElement.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<code value="Extension" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Appointment.participant.type">
<path value="Appointment.participant.type" />
<short value="Role of participant in the appointment" />
<definition value="Role of participant in the appointment." />
<comment value="The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.\n\nIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\n\nThis value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment." />
<min value="0" />
<max value="*" />
<path value="Appointment.participant.type" />
<min value="0" />
<max value="*" />
</base>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ParticipantType" />
</extension>
<strength value="extensible" />
<description value="Role of participant in encounter." />
<valueSet value="http://hl7.org/fhir/ValueSet/encounter-participant-type" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<identity value="v2" />
<map value="AIP-4, AIG-4" />
</mapping>
<identity value="rim" />
<map value="(performer | reusableDevice | subject | location).@typeCode" />
</mapping>
<identity value="ical" />
<map value="n/a" />
</mapping>
</element>
<element id="Appointment.participant.actor">
<path value="Appointment.participant.actor" />
<short value="Person, Location/HealthcareService or Device" />
<definition value="A Person, Location/HealthcareService or Device that is participating in the appointment." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="0" />
<max value="1" />
<path value="Appointment.participant.actor" />
<min value="0" />
<max value="1" />
</base>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Location" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<isSummary value="true" />
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<identity value="w5" />
<map value="FiveWs.who" />
</mapping>
<identity value="v2" />
<map value="PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3" />
</mapping>
<identity value="rim" />
<map value="performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation" />
</mapping>
<identity value="ical" />
<map value="ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"" />
</mapping>
</element>
<element id="Appointment.participant.required">
<path value="Appointment.participant.required" />
<short value="required | optional | information-only" />
<definition value="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." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<min value="0" />
<max value="1" />
<path value="Appointment.participant.required" />
<min value="0" />
<max value="1" />
</base>
<code value="code" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ParticipantRequired" />
</extension>
<strength value="required" />
<description value="Is the Participant required to attend the appointment." />
<valueSet value="http://hl7.org/fhir/ValueSet/participantrequired|4.0.1" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="rim" />
<map value="(performer | reusableDevice | subject | location).@performInd" />
</mapping>
<identity value="ical" />
<map value="ROLE=REQ-PARTICIPANT (roleparam)" />
</mapping>
</element>
<element id="Appointment.participant.status">
<path value="Appointment.participant.status" />
<short value="accepted | declined | tentative | needs-action" />
<definition value="Participation status of the actor." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<min value="1" />
<max value="1" />
<path value="Appointment.participant.status" />
<min value="1" />
<max value="1" />
</base>
<code value="code" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ParticipationStatus" />
</extension>
<strength value="required" />
<description value="The Participation status of an appointment." />
<valueSet value="http://hl7.org/fhir/ValueSet/participationstatus|4.0.1" />
</binding>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="AIP-12, AIG-14" />
</mapping>
<identity value="rim" />
<map value="(performer | reusableDevice | subject | location).statusCode" />
</mapping>
<identity value="ical" />
<map value="ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)" />
</mapping>
</element>
<element id="Appointment.participant.period">
<path value="Appointment.participant.period" />
<short value="Participation period of the actor" />
<definition value="Participation period of the actor." />
<comment value="A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration)." />
<min value="0" />
<max value="1" />
<path value="Appointment.participant.period" />
<min value="0" />
<max value="1" />
</base>
<code value="Period" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="per-1" />
<severity value="error" />
<human value="If present, start SHALL have a lower value than end" />
<expression value="start.hasValue().not() or end.hasValue().not() or (start <= end)" />
<xpath value="not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))" />
<source value="http://hl7.org/fhir/StructureDefinition/Period" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="DR" />
</mapping>
<identity value="rim" />
<map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" />
</mapping>
</element>
<element id="Appointment.requestedPeriod">
<path value="Appointment.requestedPeriod" />
<short value="Potential date/time interval(s) requested to allocate the appointment within" />
<definition value="A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.\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 value="This does not introduce a capacity for recurring appointments." />
<min value="0" />
<max value="*" />
<path value="Appointment.requestedPeriod" />
<min value="0" />
<max value="*" />
</base>
<code value="Period" />
</type>
<condition value="ele-1" />
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<key value="per-1" />
<severity value="error" />
<human value="If present, start SHALL have a lower value than end" />
<expression value="start.hasValue().not() or end.hasValue().not() or (start <= end)" />
<xpath value="not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))" />
<source value="http://hl7.org/fhir/StructureDefinition/Period" />
</constraint>
<identity value="rim" />
<map value="n/a" />
</mapping>
<identity value="v2" />
<map value="DR" />
</mapping>
<identity value="rim" />
<map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" />
</mapping>
<identity value="workflow" />
<map value="Request.occurrence[x]" />
</mapping>
<identity value="v2" />
<map value="ARQ-11" />
</mapping>
<identity value="rim" />
<map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]" />
</mapping>
</element>
</snapshot>
<element id="Appointment.extension:bookingOrganization">
<path value="Appointment.extension" />
<sliceName value="bookingOrganization" />
<short value="A reference to the source Organization of the booked appointment." />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization" />
</type>
<isModifier value="false" />
</element>
<element id="Appointment.extension:deliveryChannel">
<path value="Appointment.extension" />
<sliceName value="deliveryChannel" />
<short value="Defines the delivery channel of a scheduled appointment." />
<max value="1" />
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel" />
</type>
<isModifier value="false" />
</element>
<element id="Appointment.status">
<path value="Appointment.status" />
<short value="The overall status of the appointment." />
<mustSupport value="true" />
</element>
<element id="Appointment.serviceType">
<path value="Appointment.serviceType" />
<strength value="preferred" />
<description value="Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102." />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType" />
</binding>
</element>
<element id="Appointment.specialty">
<path value="Appointment.specialty" />
<short value="The specialty of a practitioner that would be required to perform the service requested in this appointment." />
<mustSupport value="true" />
<strength value="extensible" />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" />
</binding>
</element>
<element id="Appointment.appointmentType">
<path value="Appointment.appointmentType" />
<short value="The type of appointment or patient that has been booked in the slot." />
<mustSupport value="true" />
<strength value="extensible" />
<description value="A set of codes that define an appointment reason." />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-AppointmentReasonCode" />
</binding>
</element>
<element id="Appointment.reasonCode">
<path value="Appointment.reasonCode" />
<short value="The reason for the appointment." />
<mustSupport value="true" />
</element>
<element id="Appointment.reasonReference">
<path value="Appointment.reasonReference" />
<short value="A reference to the Observation, Condition, Procedure, or ImmunizationRecommendation that is the reason for the appointment." />
<mustSupport value="true" />
</element>
<element id="Appointment.start">
<path value="Appointment.start" />
<short value="The start time of the appointment." />
<mustSupport value="true" />
</element>
<element id="Appointment.basedOn">
<path value="Appointment.basedOn" />
<short value="The service request this appointment is allocated to assess." />
<mustSupport value="true" />
</element>
<element id="Appointment.participant">
<path value="Appointment.participant" />
<short value="A list of participants involved in the appointment." />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "UKCore-Appointment",
"url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment",
"version": "1.4.0",
"name": "UKCoreAppointment",
"title": "UK Core Appointment",
"status": "active",
"date": "2026-01-19",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "This profile defines the UK constraints and extensions on the International FHIR resource [Appointment](https://hl7.org/fhir/R4/Appointment.html).",
"purpose": "This profile allows recording of detailed information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources to be created for each instance. \n\n Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.) All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time.",
"copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Appointment",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment",
"derivation": "constraint",
"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": "*",
"base": {
"path": "Appointment",
"min": 0,
"max": "*"
},
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "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",
"expression": "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()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "app-4",
"severity": "error",
"human": "Cancelation reason is only used for appointments that have been cancelled, or no-show",
"expression": "Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.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": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "rim",
"map": "Act[@moodCode <= 'INT']"
},
{
"identity": "ical",
"map": "VEVENT"
}
]
},
{
"id": "Appointment.id",
"path": "Appointment.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "id"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.meta",
"path": "Appointment.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.implicitRules",
"path": "Appointment.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.language",
"path": "Appointment.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.text",
"path": "Appointment.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and 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.",
"comment": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Appointment.contained",
"path": "Appointment.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.extension",
"path": "Appointment.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.extension:bookingOrganization",
"path": "Appointment.extension",
"sliceName": "bookingOrganization",
"short": "A reference to the source Organization of the booked appointment.",
"definition": "An extension to record the organisation booking the appointment.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.extension:deliveryChannel",
"path": "Appointment.extension",
"sliceName": "deliveryChannel",
"short": "Defines the delivery channel of a scheduled appointment.",
"definition": "An extension to record the delivery channel of a scheduled Appointment.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.modifierExtension",
"path": "Appointment.modifierExtension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": "*",
"base": {
"path": "Appointment.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "rim",
"map": "II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]"
},
{
"identity": "servd",
"map": "Identifier"
},
{
"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": "The overall status of the appointment.",
"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",
"base": {
"path": "Appointment.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"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": {
{
"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|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.cancelationReason",
"path": "Appointment.cancelationReason",
"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.",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.cancelationReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "cancelation-reason"
}
],
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/appointment-cancellation-reason"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
}
]
},
{
"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.",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.serviceCategory",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"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"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"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": "*",
"base": {
"path": "Appointment.serviceType",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-type"
}
],
"strength": "preferred",
"description": "Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102.",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "workflow",
"map": "Request.code"
},
{
"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.",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.specialty",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "specialty"
}
],
"strength": "extensible",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".performer.AssignedPerson.code"
}
]
},
{
"id": "Appointment.appointmentType",
"path": "Appointment.appointmentType",
"short": "The type of appointment or patient that has been booked in the slot.",
"definition": "The style of appointment or patient that has been booked in the slot (not service type).",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.appointmentType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "appointment-type"
}
],
"strength": "extensible",
"description": "A set of codes that define an appointment reason.",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AppointmentReasonCode"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "v2",
"map": "ARQ-7"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "ical",
"map": "CLASSIFICATION"
}
]
},
{
"id": "Appointment.reasonCode",
"path": "Appointment.reasonCode",
"short": "The reason for the appointment.",
"definition": "The coded reason that this appointment is being scheduled. This is more clinical than administrative.",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
{
"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": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "workflow",
"map": "Request.reasonCode"
},
{
"identity": "v2",
"map": "AIS-3, SCH-7"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "Appointment.reasonReference",
"path": "Appointment.reasonReference",
"short": "A reference to the Observation, Condition, Procedure, or ImmunizationRecommendation that is the reason for the appointment.",
"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.",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.reasonReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Condition",
"http://hl7.org/fhir/StructureDefinition/Procedure",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Request.reasonReference"
},
{
"identity": "rim",
"map": ".inboundRelationship[@typeCode = 'RSON'].observation"
}
]
},
{
"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.\n\nUsing an extension to record a CodeableConcept for named values may be tested at a future connectathon.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.priority",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".text"
},
{
"identity": "ical",
"map": "SUMMARY"
}
]
},
{
"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.",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.supportingInformation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"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": "The start time of the appointment.",
"definition": "Date/Time that the appointment is to take place.",
"comment": "Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.start",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.",
"comment": "Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.end",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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",
"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.",
"comment": "32 bit number; for values larger than this, use decimal",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.minutesDuration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.slot",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Slot"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "rim",
"map": ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']"
}
]
},
{
"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",
"base": {
"path": "Appointment.created",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "rim",
"map": ".author.time"
},
{
"identity": "ical",
"map": "CREATED"
}
]
},
{
"id": "Appointment.comment",
"path": "Appointment.comment",
"short": "Additional comments",
"definition": "Additional comments about the appointment.",
"comment": "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\n\nWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.comment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.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).",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.patientInstruction",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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).",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"alias": [
"incomingReferral"
],
"min": 0,
"max": "*",
"base": {
"path": "Appointment.basedOn",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/ServiceRequest"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Request.basedOn"
},
{
"identity": "rim",
"map": ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']"
}
]
},
{
"id": "Appointment.participant",
"path": "Appointment.participant",
"short": "A list of participants involved in the appointment.",
"definition": "List of participants involved in the appointment.",
"min": 1,
"max": "*",
"base": {
"path": "Appointment.participant",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"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"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.id",
"path": "Appointment.participant.id",
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.participant.extension",
"path": "Appointment.participant.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.participant.modifierExtension",
"path": "Appointment.participant.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.\n\nIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\n\nThis value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.participant.type",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"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": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "v2",
"map": "AIP-4, AIG-4"
},
{
"identity": "rim",
"map": "(performer | reusableDevice | subject | location).@typeCode"
},
{
"identity": "ical",
"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": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.participant.actor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"http://hl7.org/fhir/StructureDefinition/Device",
"http://hl7.org/fhir/StructureDefinition/HealthcareService",
"http://hl7.org/fhir/StructureDefinition/Location"
]
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"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": "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.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.participant.required",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipantRequired"
}
],
"strength": "required",
"description": "Is the Participant required to attend the appointment.",
"valueSet": "http://hl7.org/fhir/ValueSet/participantrequired|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"min": 1,
"max": "1",
"base": {
"path": "Appointment.participant.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
{
"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|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"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.participant.period",
"path": "Appointment.participant.period",
"short": "Participation period of the actor",
"definition": "Participation period of the actor.",
"comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](datatypes.html#Duration).",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.participant.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower value than end",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source": "http://hl7.org/fhir/StructureDefinition/Period"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR"
},
{
"identity": "rim",
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
}
]
},
{
"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": "*",
"base": {
"path": "Appointment.requestedPeriod",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Period"
}
],
"ele-1"
],
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower value than end",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source": "http://hl7.org/fhir/StructureDefinition/Period"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR"
},
{
"identity": "rim",
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "v2",
"map": "ARQ-11"
},
{
"identity": "rim",
"map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]"
}
]
}
]
},
"element": [
{
"id": "Appointment.extension:bookingOrganization",
"path": "Appointment.extension",
"sliceName": "bookingOrganization",
"short": "A reference to the source Organization of the booked appointment.",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization"
]
}
],
"isModifier": false
},
{
"id": "Appointment.extension:deliveryChannel",
"path": "Appointment.extension",
"sliceName": "deliveryChannel",
"short": "Defines the delivery channel of a scheduled appointment.",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel"
]
}
],
"isModifier": false
},
{
"id": "Appointment.status",
"path": "Appointment.status",
"short": "The overall status of the appointment.",
"mustSupport": true
},
{
"id": "Appointment.serviceType",
"path": "Appointment.serviceType",
"binding": {
"strength": "preferred",
"description": "Any code from the SNOMED CT UK Refset with fully specified name 'Services simple reference set (foundation metadata concept)' with Refset Id 1127531000000102.",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType"
}
},
{
"id": "Appointment.specialty",
"path": "Appointment.specialty",
"short": "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode"
}
},
{
"id": "Appointment.appointmentType",
"path": "Appointment.appointmentType",
"short": "The type of appointment or patient that has been booked in the slot.",
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "A set of codes that define an appointment reason.",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-AppointmentReasonCode"
}
},
{
"id": "Appointment.reasonCode",
"path": "Appointment.reasonCode",
"short": "The reason for the appointment.",
"mustSupport": true
},
{
"id": "Appointment.reasonReference",
"path": "Appointment.reasonReference",
"short": "A reference to the Observation, Condition, Procedure, or ImmunizationRecommendation that is the reason for the appointment.",
"mustSupport": true
},
{
"id": "Appointment.start",
"path": "Appointment.start",
"short": "The start time of the appointment.",
"mustSupport": true
},
{
"id": "Appointment.basedOn",
"path": "Appointment.basedOn",
"short": "The service request this appointment is allocated to assess.",
"mustSupport": true
},
{
"id": "Appointment.participant",
"path": "Appointment.participant",
"short": "A list of participants involved in the appointment.",
"mustSupport": true
}
]
}
}

Examples

Orthopaedic Surgery - An example to illustrate an Orthopaedic Surgery appointment.

UKCore-Appointment-OrthopaedicSurgery-Example



Booking Organization - An example to illustrate the booking organization extension associated with an appointment.

Example-UKCore-Extension-BookingOrganization



Delivery Channel - An example to illustrate the delivery channel associated with an appointment.

Example-UKCore-Extension-DeliveryChannel