Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_Appointment_R5

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Appointment Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_Appointment_R5

This cross-version profile allows STU3 Appointment content to be represented via FHIR R5 Appointment resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment(5.0.0) 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:indication 0..* Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: Reason the appointment is to takes place (resource) (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.indication
Constraints: ext-1
... status ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... start ΣC 0..1 instant When appointment is to take place
... end ΣC 0..1 instant When appointment is to conclude
... participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required Appointment Status 📍5.0.0 FHIR Std.
Appointment.participant.​status Base required Participation Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancellation reason is only used for appointments that have been cancelled, or noshow cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5 error Appointment The start must be less than or equal to the end start.exists() implies start <= end
app-6 best practice Appointment An appointment may have an originatingAppointment or recurrenceTemplate, but not both originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7 error Appointment Cancellation date is only used for appointments that have been cancelled, or noshow cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error Appointment.implicitRules, Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.status, Appointment.start, Appointment.end, Appointment.participant, Appointment.participant.modifierExtension, Appointment.participant.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.participant.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment(5.0.0) 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)
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:indication 0..* Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: Reason the appointment is to takes place (resource) (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.indication
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.identifier
... priority
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:priority 0..1 unsignedInt STU3: priority additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.priority
... supportingInformation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:supportingInformation 0..* Reference(Resource) STU3: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... requestedPeriod
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:requestedPeriod 0..* Period STU3: requestedPeriod additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.requestedPeriod
... slot
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:slot 0..* Reference(Resource) STU3: slot additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:comment 0..1 string STU3: comment additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.comment
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:incomingReferral 0..* Reference(Resource) STU3: The ReferralRequest provided as information to allocate to the Encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... participant
.... actor
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 0..1 Reference(Resource) STU3: Person, Location/HealthcareService or Device
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... required
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:required 0..1 code STU3: required | optional | information-only additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.participant.required
Binding: R3ParticipantrequiredForR5 (0.1.0) (required): Is the Participant required to attend the appointment.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment(5.0.0) 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages . Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:indication 0..* Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: Reason the appointment is to takes place (resource) (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.indication
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier External Ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancellationReason ΣC 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... class Σ 0..* CodeableConcept ​Classification when becoming an encounter
Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter.
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableReference(HealthcareService) The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: Hl7VSAppointmentReasonCodes (3.0.0) (preferred)
... reason Σ 0..* CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... priority 0..1 CodeableConcept Used to make informed decisions if needing to re-prioritize
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the appointment.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:priority 0..1 unsignedInt STU3: priority additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.priority
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... replaces 0..* Reference(Appointment) Appointment replaced by this Appointment
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:supportingInformation 0..1 Reference(Resource) STU3: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... previousAppointment 0..1 Reference(Appointment) The previous appointment in a series
... originatingAppointment C 0..1 Reference(Appointment) The originating appointment in a recurring set of appointments
... start ΣC 0..1 instant When appointment is to take place
... end ΣC 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:requestedPeriod 0..* Period STU3: requestedPeriod additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.requestedPeriod
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... slot 0..* Reference(Slot) The slots that this appointment is filling
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:slot 0..1 Reference(Resource) STU3: slot additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Appointment
... created 0..1 dateTime The date that this appointment was initially created
... cancellationDate C 0..1 dateTime When the appointment was cancelled
... note 0..* Annotation Additional comments
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:comment 0..1 string STU3: comment additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.comment
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... patientInstruction 0..* CodeableReference(DocumentReference | Binary | Communication) Detailed information and instructions for the patient
... basedOn 0..* Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) The request this appointment is allocated to assess
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:incomingReferral 0..1 Reference(Resource) STU3: The ReferralRequest provided as information to allocate to the Encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... subject Σ 0..1 Reference(Patient | Group) The patient or group associated with the appointment
... participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type ΣC 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType . (extensible): Role of participant in encounter.
.... period 0..1 Period Participation period of the actor
.... actor ΣC 0..1 Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) The individual, device, location, or service participating in the appointment
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:actor 0..1 Reference(Resource) STU3: Person, Location/HealthcareService or Device
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:required 0..1 code STU3: required | optional | information-only additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.participant.required
Binding: R3ParticipantrequiredForR5 (0.1.0) (required): Is the Participant required to attend the appointment.
Constraints: ext-1
..... value 0..1 boolean Primitive value for boolean
.... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... recurrenceId 0..1 positiveInt The sequence number in the recurrence
... occurrenceChanged 0..1 boolean Indicates that this appointment varies from a recurrence pattern
... recurrenceTemplate C 0..* BackboneElement Details of the recurrence pattern/template used to generate occurrences
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... timezone 0..1 CodeableConcept The timezone of the occurrences
Binding: IANATimezones (required): IANA Timezones (BCP 175)
.... recurrenceType 1..1 CodeableConcept The frequency of the recurrence
Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175)
.... lastOccurrenceDate 0..1 date The date when the recurrence should end
.... occurrenceCount 0..1 positiveInt The number of planned occurrences
.... occurrenceDate 0..* date Specific dates for a recurring set of appointments (no template)
.... weeklyTemplate 0..1 BackboneElement Information about weekly recurring appointments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... monday 0..1 boolean Recurs on Mondays
..... tuesday 0..1 boolean Recurs on Tuesday
..... wednesday 0..1 boolean Recurs on Wednesday
..... thursday 0..1 boolean Recurs on Thursday
..... friday 0..1 boolean Recurs on Friday
..... saturday 0..1 boolean Recurs on Saturday
..... sunday 0..1 boolean Recurs on Sunday
..... weekInterval 0..1 positiveInt Recurs every nth week
.... monthlyTemplate 0..1 BackboneElement Information about monthly recurring appointments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... dayOfMonth 0..1 positiveInt Recurs on a specific day of the month
..... nthWeekOfMonth 0..1 Coding Indicates which week of the month the appointment should occur
Binding: WeekOfMonth (required): The set of weeks in a month.
..... dayOfWeek 0..1 Coding Indicates which day of the week the appointment should occur
Binding: DaysOfWeek (required): The days of the week.
..... monthInterval 1..1 positiveInt Recurs every nth month
.... yearlyTemplate 0..1 BackboneElement Information about yearly recurring appointments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... yearInterval 1..1 positiveInt Recurs every nth year
.... excludingDate 0..* date Any dates that should be excluded from the series
.... excludingRecurrenceId 0..* positiveInt Any recurrence IDs that should be excluded from the recurrence

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Appointment.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Appointment.language Base required All Languages 📍5.0.0 FHIR Std.
Appointment.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Appointment.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Appointment.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Appointment.status Base required Appointment Status 📍5.0.0 FHIR Std.
Appointment.cancellationReason Base example Appointment Cancellation Reason 📍5.0.0 FHIR Std.
Appointment.class Base preferred ​ http://terminology.hl7.org/ValueSet/EncounterClass Not State Unknown
Appointment.serviceCategory Base example Service Category 📍5.0.0 FHIR Std.
Appointment.serviceType Base example Service Type 📍5.0.0 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📍3.0.0 THO v7.1
Appointment.reason Base preferred Encounter Reason Codes 📍5.0.0 FHIR Std.
Appointment.priority Base example ActPriority 📍3.0.0 THO v7.1
Appointment.supportingInformation.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.slot.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.basedOn.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.participant.​type Base extensible Participant Type . 📍5.0.0 tx.fhir.org
Appointment.participant.​actor.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.participant.​status Base required Participation Status 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​timezone Base required IANA Timezones 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​recurrenceType Base preferred Appointment Recurrence Type 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​monthlyTemplate.nthWeekOfMonth Base required Week Of Month 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​monthlyTemplate.dayOfWeek Base required Days Of Week 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancellation reason is only used for appointments that have been cancelled, or noshow cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5 error Appointment The start must be less than or equal to the end start.exists() implies start <= end
app-6 best practice Appointment An appointment may have an originatingAppointment or recurrenceTemplate, but not both originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7 error Appointment Cancellation date is only used for appointments that have been cancelled, or noshow cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error Appointment.meta, Appointment.meta.extension, Appointment.meta.extension:meta, Appointment.meta.versionId, Appointment.meta.lastUpdated, Appointment.meta.source, Appointment.meta.profile, Appointment.meta.security, Appointment.meta.tag, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.text.extension, Appointment.text.extension:text, Appointment.text.status, Appointment.text.div, Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.identifier, Appointment.identifier.extension, Appointment.identifier.extension:identifier, Appointment.identifier.use, Appointment.identifier.type, Appointment.identifier.system, Appointment.identifier.value, Appointment.identifier.period, Appointment.identifier.assigner, Appointment.status, Appointment.cancellationReason, Appointment.class, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reason, Appointment.priority, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.priority.coding, Appointment.priority.text, Appointment.description, Appointment.replaces, Appointment.virtualService, Appointment.supportingInformation, Appointment.supportingInformation.extension, Appointment.supportingInformation.extension:supportingInformation, Appointment.supportingInformation.reference, Appointment.supportingInformation.type, Appointment.supportingInformation.identifier, Appointment.supportingInformation.display, Appointment.previousAppointment, Appointment.originatingAppointment, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.requestedPeriod, Appointment.requestedPeriod.extension, Appointment.requestedPeriod.extension:requestedPeriod, Appointment.requestedPeriod.start, Appointment.requestedPeriod.end, Appointment.slot, Appointment.slot.extension, Appointment.slot.extension:slot, Appointment.slot.reference, Appointment.slot.type, Appointment.slot.identifier, Appointment.slot.display, Appointment.account, Appointment.created, Appointment.cancellationDate, Appointment.note, Appointment.note.extension, Appointment.note.extension:comment, Appointment.note.author[x], Appointment.note.time, Appointment.note.text, Appointment.patientInstruction, Appointment.basedOn, Appointment.basedOn.extension, Appointment.basedOn.extension:incomingReferral, Appointment.basedOn.reference, Appointment.basedOn.type, Appointment.basedOn.identifier, Appointment.basedOn.display, Appointment.subject, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, Appointment.participant.period, Appointment.participant.actor, Appointment.participant.actor.extension, Appointment.participant.actor.extension:actor, Appointment.participant.actor.reference, Appointment.participant.actor.type, Appointment.participant.actor.identifier, Appointment.participant.actor.display, Appointment.participant.required, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.participant.status, Appointment.recurrenceId, Appointment.occurrenceChanged, Appointment.recurrenceTemplate, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.timezone, Appointment.recurrenceTemplate.recurrenceType, Appointment.recurrenceTemplate.lastOccurrenceDate, Appointment.recurrenceTemplate.occurrenceCount, Appointment.recurrenceTemplate.occurrenceDate, Appointment.recurrenceTemplate.weeklyTemplate, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.monday, Appointment.recurrenceTemplate.weeklyTemplate.tuesday, Appointment.recurrenceTemplate.weeklyTemplate.wednesday, Appointment.recurrenceTemplate.weeklyTemplate.thursday, Appointment.recurrenceTemplate.weeklyTemplate.friday, Appointment.recurrenceTemplate.weeklyTemplate.saturday, Appointment.recurrenceTemplate.weeklyTemplate.sunday, Appointment.recurrenceTemplate.weeklyTemplate.weekInterval, Appointment.recurrenceTemplate.monthlyTemplate, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.dayOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek, Appointment.recurrenceTemplate.monthlyTemplate.monthInterval, Appointment.recurrenceTemplate.yearlyTemplate, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.yearInterval, Appointment.recurrenceTemplate.excludingDate, Appointment.recurrenceTemplate.excludingRecurrenceId All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Appointment.meta.extension, Appointment.meta.extension:meta, Appointment.text.extension, Appointment.text.extension:text, Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.identifier.extension, Appointment.identifier.extension:identifier, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.supportingInformation.extension, Appointment.supportingInformation.extension:supportingInformation, Appointment.requestedPeriod.extension, Appointment.requestedPeriod.extension:requestedPeriod, Appointment.slot.extension, Appointment.slot.extension:slot, Appointment.note.extension, Appointment.note.extension:comment, Appointment.basedOn.extension, Appointment.basedOn.extension:incomingReferral, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.actor.extension, Appointment.participant.actor.extension:actor, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Appointment.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Appointment.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment(5.0.0) 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:indication 0..* Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: Reason the appointment is to takes place (resource) (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.indication
Constraints: ext-1
... status ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... start ΣC 0..1 instant When appointment is to take place
... end ΣC 0..1 instant When appointment is to conclude
... participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required Appointment Status 📍5.0.0 FHIR Std.
Appointment.participant.​status Base required Participation Status 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancellation reason is only used for appointments that have been cancelled, or noshow cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5 error Appointment The start must be less than or equal to the end start.exists() implies start <= end
app-6 best practice Appointment An appointment may have an originatingAppointment or recurrenceTemplate, but not both originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7 error Appointment Cancellation date is only used for appointments that have been cancelled, or noshow cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error Appointment.implicitRules, Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.status, Appointment.start, Appointment.end, Appointment.participant, Appointment.participant.modifierExtension, Appointment.participant.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.participant.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment(5.0.0) 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)
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:indication 0..* Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: Reason the appointment is to takes place (resource) (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.indication
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.identifier
... priority
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:priority 0..1 unsignedInt STU3: priority additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.priority
... supportingInformation
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:supportingInformation 0..* Reference(Resource) STU3: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... requestedPeriod
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:requestedPeriod 0..* Period STU3: requestedPeriod additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.requestedPeriod
... slot
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:slot 0..* Reference(Resource) STU3: slot additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:comment 0..1 string STU3: comment additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.comment
... basedOn
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:incomingReferral 0..* Reference(Resource) STU3: The ReferralRequest provided as information to allocate to the Encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... participant
.... actor
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actor 0..1 Reference(Resource) STU3: Person, Location/HealthcareService or Device
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... required
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:required 0..1 code STU3: required | optional | information-only additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.participant.required
Binding: R3ParticipantrequiredForR5 (0.1.0) (required): Is the Participant required to attend the appointment.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment(5.0.0) 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)
Constraints: app-2, app-3, app-4, app-5, app-6, app-7
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages . Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:indication 0..* Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) STU3: Reason the appointment is to takes place (resource) (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.indication
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier External Ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!ΣC 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancellationReason ΣC 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... class Σ 0..* CodeableConcept ​Classification when becoming an encounter
Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter.
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableReference(HealthcareService) The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: Hl7VSAppointmentReasonCodes (3.0.0) (preferred)
... reason Σ 0..* CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... priority 0..1 CodeableConcept Used to make informed decisions if needing to re-prioritize
Binding: ActPriority (3.0.0) (example): Indicates the urgency of the appointment.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:priority 0..1 unsignedInt STU3: priority additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.priority
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... replaces 0..* Reference(Appointment) Appointment replaced by this Appointment
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:supportingInformation 0..1 Reference(Resource) STU3: supportingInformation additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... previousAppointment 0..1 Reference(Appointment) The previous appointment in a series
... originatingAppointment C 0..1 Reference(Appointment) The originating appointment in a recurring set of appointments
... start ΣC 0..1 instant When appointment is to take place
... end ΣC 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:requestedPeriod 0..* Period STU3: requestedPeriod additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.requestedPeriod
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... slot 0..* Reference(Slot) The slots that this appointment is filling
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:slot 0..1 Reference(Resource) STU3: slot additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... account 0..* Reference(Account) The set of accounts that may be used for billing for this Appointment
... created 0..1 dateTime The date that this appointment was initially created
... cancellationDate C 0..1 dateTime When the appointment was cancelled
... note 0..* Annotation Additional comments
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:comment 0..1 string STU3: comment additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.comment
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... patientInstruction 0..* CodeableReference(DocumentReference | Binary | Communication) Detailed information and instructions for the patient
... basedOn 0..* Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) The request this appointment is allocated to assess
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:incomingReferral 0..1 Reference(Resource) STU3: The ReferralRequest provided as information to allocate to the Encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... subject Σ 0..1 Reference(Patient | Group) The patient or group associated with the appointment
... participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type ΣC 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType . (extensible): Role of participant in encounter.
.... period 0..1 Period Participation period of the actor
.... actor ΣC 0..1 Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) The individual, device, location, or service participating in the appointment
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:actor 0..1 Reference(Resource) STU3: Person, Location/HealthcareService or Device
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... required Σ 0..1 boolean The participant is required to attend (optional when false)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:required 0..1 code STU3: required | optional | information-only additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Appointment.participant.required
Binding: R3ParticipantrequiredForR5 (0.1.0) (required): Is the Participant required to attend the appointment.
Constraints: ext-1
..... value 0..1 boolean Primitive value for boolean
.... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... recurrenceId 0..1 positiveInt The sequence number in the recurrence
... occurrenceChanged 0..1 boolean Indicates that this appointment varies from a recurrence pattern
... recurrenceTemplate C 0..* BackboneElement Details of the recurrence pattern/template used to generate occurrences
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... timezone 0..1 CodeableConcept The timezone of the occurrences
Binding: IANATimezones (required): IANA Timezones (BCP 175)
.... recurrenceType 1..1 CodeableConcept The frequency of the recurrence
Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175)
.... lastOccurrenceDate 0..1 date The date when the recurrence should end
.... occurrenceCount 0..1 positiveInt The number of planned occurrences
.... occurrenceDate 0..* date Specific dates for a recurring set of appointments (no template)
.... weeklyTemplate 0..1 BackboneElement Information about weekly recurring appointments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... monday 0..1 boolean Recurs on Mondays
..... tuesday 0..1 boolean Recurs on Tuesday
..... wednesday 0..1 boolean Recurs on Wednesday
..... thursday 0..1 boolean Recurs on Thursday
..... friday 0..1 boolean Recurs on Friday
..... saturday 0..1 boolean Recurs on Saturday
..... sunday 0..1 boolean Recurs on Sunday
..... weekInterval 0..1 positiveInt Recurs every nth week
.... monthlyTemplate 0..1 BackboneElement Information about monthly recurring appointments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... dayOfMonth 0..1 positiveInt Recurs on a specific day of the month
..... nthWeekOfMonth 0..1 Coding Indicates which week of the month the appointment should occur
Binding: WeekOfMonth (required): The set of weeks in a month.
..... dayOfWeek 0..1 Coding Indicates which day of the week the appointment should occur
Binding: DaysOfWeek (required): The days of the week.
..... monthInterval 1..1 positiveInt Recurs every nth month
.... yearlyTemplate 0..1 BackboneElement Information about yearly recurring appointments
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... yearInterval 1..1 positiveInt Recurs every nth year
.... excludingDate 0..* date Any dates that should be excluded from the series
.... excludingRecurrenceId 0..* positiveInt Any recurrence IDs that should be excluded from the recurrence

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Appointment.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Appointment.language Base required All Languages 📍5.0.0 FHIR Std.
Appointment.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Appointment.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Appointment.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Appointment.status Base required Appointment Status 📍5.0.0 FHIR Std.
Appointment.cancellationReason Base example Appointment Cancellation Reason 📍5.0.0 FHIR Std.
Appointment.class Base preferred ​ http://terminology.hl7.org/ValueSet/EncounterClass Not State Unknown
Appointment.serviceCategory Base example Service Category 📍5.0.0 FHIR Std.
Appointment.serviceType Base example Service Type 📍5.0.0 FHIR Std.
Appointment.specialty Base preferred Practice Setting Code Value Set 📍5.0.0 FHIR Std.
Appointment.appointmentType Base preferred hl7VS-appointmentReasonCodes 📍3.0.0 THO v7.1
Appointment.reason Base preferred Encounter Reason Codes 📍5.0.0 FHIR Std.
Appointment.priority Base example ActPriority 📍3.0.0 THO v7.1
Appointment.supportingInformation.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.slot.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.basedOn.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.participant.​type Base extensible Participant Type . 📍5.0.0 tx.fhir.org
Appointment.participant.​actor.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Appointment.participant.​status Base required Participation Status 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​timezone Base required IANA Timezones 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​recurrenceType Base preferred Appointment Recurrence Type 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​monthlyTemplate.nthWeekOfMonth Base required Week Of Month 📍5.0.0 FHIR Std.
Appointment.recurrenceTemplate.​monthlyTemplate.dayOfWeek Base required Days Of Week 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 error Appointment Either start and end are specified, or neither start.exists() = end.exists()
app-3 error Appointment Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 error Appointment Cancellation reason is only used for appointments that have been cancelled, or noshow cancellationReason.exists() implies (status='noshow' or status='cancelled')
app-5 error Appointment The start must be less than or equal to the end start.exists() implies start <= end
app-6 best practice Appointment An appointment may have an originatingAppointment or recurrenceTemplate, but not both originatingAppointment.exists().not() or recurrenceTemplate.exists().not()
app-7 error Appointment Cancellation date is only used for appointments that have been cancelled, or noshow cancellationDate.exists() implies (status='noshow' or status='cancelled')
dom-2 error Appointment If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Appointment 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Appointment If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Appointment If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Appointment A resource should have narrative for robust management text.`div`.exists()
ele-1 error Appointment.meta, Appointment.meta.extension, Appointment.meta.extension:meta, Appointment.meta.versionId, Appointment.meta.lastUpdated, Appointment.meta.source, Appointment.meta.profile, Appointment.meta.security, Appointment.meta.tag, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.text.extension, Appointment.text.extension:text, Appointment.text.status, Appointment.text.div, Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.identifier, Appointment.identifier.extension, Appointment.identifier.extension:identifier, Appointment.identifier.use, Appointment.identifier.type, Appointment.identifier.system, Appointment.identifier.value, Appointment.identifier.period, Appointment.identifier.assigner, Appointment.status, Appointment.cancellationReason, Appointment.class, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reason, Appointment.priority, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.priority.coding, Appointment.priority.text, Appointment.description, Appointment.replaces, Appointment.virtualService, Appointment.supportingInformation, Appointment.supportingInformation.extension, Appointment.supportingInformation.extension:supportingInformation, Appointment.supportingInformation.reference, Appointment.supportingInformation.type, Appointment.supportingInformation.identifier, Appointment.supportingInformation.display, Appointment.previousAppointment, Appointment.originatingAppointment, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.requestedPeriod, Appointment.requestedPeriod.extension, Appointment.requestedPeriod.extension:requestedPeriod, Appointment.requestedPeriod.start, Appointment.requestedPeriod.end, Appointment.slot, Appointment.slot.extension, Appointment.slot.extension:slot, Appointment.slot.reference, Appointment.slot.type, Appointment.slot.identifier, Appointment.slot.display, Appointment.account, Appointment.created, Appointment.cancellationDate, Appointment.note, Appointment.note.extension, Appointment.note.extension:comment, Appointment.note.author[x], Appointment.note.time, Appointment.note.text, Appointment.patientInstruction, Appointment.basedOn, Appointment.basedOn.extension, Appointment.basedOn.extension:incomingReferral, Appointment.basedOn.reference, Appointment.basedOn.type, Appointment.basedOn.identifier, Appointment.basedOn.display, Appointment.subject, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, Appointment.participant.period, Appointment.participant.actor, Appointment.participant.actor.extension, Appointment.participant.actor.extension:actor, Appointment.participant.actor.reference, Appointment.participant.actor.type, Appointment.participant.actor.identifier, Appointment.participant.actor.display, Appointment.participant.required, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.participant.status, Appointment.recurrenceId, Appointment.occurrenceChanged, Appointment.recurrenceTemplate, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.timezone, Appointment.recurrenceTemplate.recurrenceType, Appointment.recurrenceTemplate.lastOccurrenceDate, Appointment.recurrenceTemplate.occurrenceCount, Appointment.recurrenceTemplate.occurrenceDate, Appointment.recurrenceTemplate.weeklyTemplate, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.monday, Appointment.recurrenceTemplate.weeklyTemplate.tuesday, Appointment.recurrenceTemplate.weeklyTemplate.wednesday, Appointment.recurrenceTemplate.weeklyTemplate.thursday, Appointment.recurrenceTemplate.weeklyTemplate.friday, Appointment.recurrenceTemplate.weeklyTemplate.saturday, Appointment.recurrenceTemplate.weeklyTemplate.sunday, Appointment.recurrenceTemplate.weeklyTemplate.weekInterval, Appointment.recurrenceTemplate.monthlyTemplate, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.dayOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth, Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek, Appointment.recurrenceTemplate.monthlyTemplate.monthInterval, Appointment.recurrenceTemplate.yearlyTemplate, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.yearInterval, Appointment.recurrenceTemplate.excludingDate, Appointment.recurrenceTemplate.excludingRecurrenceId All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Appointment.meta.extension, Appointment.meta.extension:meta, Appointment.text.extension, Appointment.text.extension:text, Appointment.extension, Appointment.extension:indication, Appointment.modifierExtension, Appointment.identifier.extension, Appointment.identifier.extension:identifier, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.supportingInformation.extension, Appointment.supportingInformation.extension:supportingInformation, Appointment.requestedPeriod.extension, Appointment.requestedPeriod.extension:requestedPeriod, Appointment.slot.extension, Appointment.slot.extension:slot, Appointment.note.extension, Appointment.note.extension:comment, Appointment.basedOn.extension, Appointment.basedOn.extension:incomingReferral, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.actor.extension, Appointment.participant.actor.extension:actor, Appointment.participant.required.extension, Appointment.participant.required.extension:required, Appointment.recurrenceTemplate.extension, Appointment.recurrenceTemplate.modifierExtension, Appointment.recurrenceTemplate.weeklyTemplate.extension, Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension, Appointment.recurrenceTemplate.monthlyTemplate.extension, Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension, Appointment.recurrenceTemplate.yearlyTemplate.extension, Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Appointment.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Appointment.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron