Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Appointment | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_Appointment_R4B | ||
This cross-version profile allows R5 Appointment content to be represented via FHIR R4B Appointment resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | AppointmentStatus | 📍4.3.0 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.3.0 | FHIR Std. |
| 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | 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.exists() and ('#'+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(uri) = '#').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:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, Appointment.modifierExtension, Appointment.status, 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:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, Appointment.modifierExtension, Appointment.participant.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  Appointment |
C | 0..* | Appointment(4.3.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 | ||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
   extension:class |
0..* | CodeableConcept | R5: Classification when becoming an encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class Constraints: ext-1 | |||||
| extension:reason |
0..* | CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4B(0.1.0) | ImmunizationRecommendation) | R5: Reason this appointment is scheduled additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason Constraints: ext-1 | |||||
| extension:replaces |
0..* | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment) | R5: Appointment replaced by this Appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces Constraints: ext-1 | |||||
| extension:virtualService |
0..* | (Complex) | R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.virtualService Constraints: ext-1 | |||||
| extension:previousAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment) | R5: The previous appointment in a series (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.previousAppointment Constraints: ext-1 | |||||
| extension:originatingAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment) | R5: The originating appointment in a recurring set of appointments (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.originatingAppointment Constraints: ext-1 | |||||
| extension:account |
0..* | Reference(Cross-version Profile for R5.Account for use in FHIR R4B(0.1.0) | Account) | R5: The set of accounts that may be used for billing for this Appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.account Constraints: ext-1 | |||||
| extension:cancellationDate |
0..1 | dateTime | R5: When the appointment was cancelled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationDate Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Group for use in FHIR R4B(0.1.0) | Group) | R5: The patient or group associated with the appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.subject Constraints: ext-1 | |||||
| extension:recurrenceId |
0..1 | positiveInt | R5: The sequence number in the recurrence (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceId Constraints: ext-1 | |||||
| extension:occurrenceChanged |
0..1 | boolean | R5: Indicates that this appointment varies from a recurrence pattern (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.occurrenceChanged Constraints: ext-1 | |||||
 extension:recurrenceTemplate |
0..* | (Complex) | R5: Details of the recurrence pattern/template used to generate occurrences (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceTemplate Constraints: ext-1 | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!Σ | 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. | ||||
| cancelationReason |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| 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:serviceType |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService) | R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.serviceType Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
 text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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) | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
 reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
| priority |
0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
| 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:priority |
0..1 | CodeableConcept | R5: priority additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.priority Binding: http://terminology.hl7.org/ValueSet/v3-ActPriority|2.0.0 (example): Indicates the urgency of the appointment. Constraints: ext-1 | |||||
| value |
0..1 | unsignedInt | Primitive value for unsignedInt | |||||
| description |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| start |
Σ | 0..1 | instant | When appointment is to take place | ||||
| end |
Σ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created |
0..1 | dateTime | The date that this appointment was initially created | |||||
| comment |
0..1 | string | Additional comments | |||||
| 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:note |
0..* | Annotation | R5: note additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| patientInstruction |
0..1 | string | Detailed information and instructions for the patient | |||||
| 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:patientInstruction |
0..* | CodeableReference(Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media | Cross-version Profile for R5.Binary for use in FHIR R4B(0.1.0) | Binary | Cross-version Profile for R5.Communication for use in FHIR R4B(0.1.0) | Communication) | R5: patientInstruction additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.patientInstruction Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The service 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:basedOn |
0..1 | Reference(Resource) | R5: The request this appointment is allocated to assess 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") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| 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) | R5: The individual, device, location, or service participating in the appointment 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") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| required |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| 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 | boolean | R5: The participant is required to attend (optional when false) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.required Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.3.0 | FHIR Std. |
| Appointment.cancelationReason | Base | example | AppointmentCancellationReason | 📍4.3.0 | FHIR Std. |
| Appointment.serviceCategory | Base | example | ServiceCategory | 📍4.3.0 | FHIR Std. |
| Appointment.serviceType | Base | example | ServiceType | 📍4.3.0 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.3.0 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📍3.0.0 | THO v7.1 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.3.0 | FHIR Std. |
| Appointment.basedOn.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Appointment.participant.type | Base | extensible | ParticipantType | 📍4.3.0 | FHIR Std. |
| Appointment.participant.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.3.0 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.3.0 | FHIR Std. |
| 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Appointment.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Appointment.meta, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.extension, Appointment.extension:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, Appointment.modifierExtension, Appointment.identifier, Appointment.status, Appointment.cancelationReason, Appointment.serviceCategory, Appointment.serviceType, Appointment.serviceType.extension, Appointment.serviceType.extension:serviceType, Appointment.serviceType.coding, Appointment.serviceType.text, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.reasonReference, Appointment.priority, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.description, Appointment.supportingInformation, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.slot, Appointment.created, Appointment.comment, Appointment.comment.extension, Appointment.comment.extension:note, Appointment.patientInstruction, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.basedOn, Appointment.basedOn.extension, Appointment.basedOn.extension:basedOn, Appointment.basedOn.reference, Appointment.basedOn.type, Appointment.basedOn.identifier, Appointment.basedOn.display, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, 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.participant.period, Appointment.requestedPeriod | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Appointment.extension, Appointment.extension:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, Appointment.modifierExtension, Appointment.serviceType.extension, Appointment.serviceType.extension:serviceType, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.comment.extension, Appointment.comment.extension:note, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.basedOn.extension, Appointment.basedOn.extension:basedOn, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.actor.extension, Appointment.participant.actor.extension:actor, Appointment.participant.required.extension, Appointment.participant.required.extension:required | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.status | Base | required | AppointmentStatus | 📍4.3.0 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.3.0 | FHIR Std. |
| 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | 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.exists() and ('#'+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(uri) = '#').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:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, Appointment.modifierExtension, Appointment.status, 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:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, 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
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment(4.3.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 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:class |
0..* | CodeableConcept | R5: Classification when becoming an encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class Constraints: ext-1 | |||||
| extension:reason |
0..* | CodeableReference(Cross-version Profile for R5.Condition for use in FHIR R4B(0.1.0) | Condition | Cross-version Profile for R5.Procedure for use in FHIR R4B(0.1.0) | Procedure | Cross-version Profile for R5.Observation for use in FHIR R4B(0.1.0) | Observation | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4B(0.1.0) | ImmunizationRecommendation) | R5: Reason this appointment is scheduled additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason Constraints: ext-1 | |||||
| extension:replaces |
0..* | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment) | R5: Appointment replaced by this Appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces Constraints: ext-1 | |||||
| extension:virtualService |
0..* | (Complex) | R5: Connection details of a virtual service (e.g. conference call) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.virtualService Constraints: ext-1 | |||||
| extension:previousAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment) | R5: The previous appointment in a series (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.previousAppointment Constraints: ext-1 | |||||
| extension:originatingAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment) | R5: The originating appointment in a recurring set of appointments (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.originatingAppointment Constraints: ext-1 | |||||
| extension:account |
0..* | Reference(Cross-version Profile for R5.Account for use in FHIR R4B(0.1.0) | Account) | R5: The set of accounts that may be used for billing for this Appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.account Constraints: ext-1 | |||||
| extension:cancellationDate |
0..1 | dateTime | R5: When the appointment was cancelled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationDate Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Cross-version Profile for R5.Patient for use in FHIR R4B(0.1.0) | Patient | Cross-version Profile for R5.Group for use in FHIR R4B(0.1.0) | Group) | R5: The patient or group associated with the appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.subject Constraints: ext-1 | |||||
| extension:recurrenceId |
0..1 | positiveInt | R5: The sequence number in the recurrence (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceId Constraints: ext-1 | |||||
| extension:occurrenceChanged |
0..1 | boolean | R5: Indicates that this appointment varies from a recurrence pattern (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.occurrenceChanged Constraints: ext-1 | |||||
| extension:recurrenceTemplate |
0..* | (Complex) | R5: Details of the recurrence pattern/template used to generate occurrences (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceTemplate Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!Σ | 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. | ||||
| cancelationReason |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| 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:serviceType |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4B(0.1.0) | HealthcareService) | R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.serviceType Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| 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) | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| reasonReference |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||
| priority |
0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
| 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:priority |
0..1 | CodeableConcept | R5: priority additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.priority Binding: http://terminology.hl7.org/ValueSet/v3-ActPriority|2.0.0 (example): Indicates the urgency of the appointment. Constraints: ext-1 | |||||
| value |
0..1 | unsignedInt | Primitive value for unsignedInt | |||||
| description |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| start |
Σ | 0..1 | instant | When appointment is to take place | ||||
| end |
Σ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created |
0..1 | dateTime | The date that this appointment was initially created | |||||
| comment |
0..1 | string | Additional comments | |||||
| 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:note |
0..* | Annotation | R5: note additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| patientInstruction |
0..1 | string | Detailed information and instructions for the patient | |||||
| 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:patientInstruction |
0..* | CodeableReference(Cross-version Profile for R5.DocumentReference for use in FHIR R4B(0.1.0) | Media | Cross-version Profile for R5.Binary for use in FHIR R4B(0.1.0) | Binary | Cross-version Profile for R5.Communication for use in FHIR R4B(0.1.0) | Communication) | R5: patientInstruction additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.patientInstruction Constraints: ext-1 | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| basedOn |
0..* | Reference(ServiceRequest) | The service 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:basedOn |
0..1 | Reference(Resource) | R5: The request this appointment is allocated to assess 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") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| 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) | R5: The individual, device, location, or service participating in the appointment 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") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| required |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| 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 | boolean | R5: The participant is required to attend (optional when false) additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.required Constraints: ext-1 | |||||
| value |
0..1 | code | Primitive value for code | |||||
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.3.0 | FHIR Std. |
| Appointment.cancelationReason | Base | example | AppointmentCancellationReason | 📍4.3.0 | FHIR Std. |
| Appointment.serviceCategory | Base | example | ServiceCategory | 📍4.3.0 | FHIR Std. |
| Appointment.serviceType | Base | example | ServiceType | 📍4.3.0 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍4.3.0 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | hl7VS-appointmentReasonCodes | 📍3.0.0 | THO v7.1 |
| Appointment.reasonCode | Base | preferred | Encounter Reason Codes | 📍4.3.0 | FHIR Std. |
| Appointment.basedOn.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Appointment.participant.type | Base | extensible | ParticipantType | 📍4.3.0 | FHIR Std. |
| Appointment.participant.actor.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.3.0 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.3.0 | FHIR Std. |
| 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | Appointment.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Appointment.meta, Appointment.implicitRules, Appointment.language, Appointment.text, Appointment.extension, Appointment.extension:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, Appointment.modifierExtension, Appointment.identifier, Appointment.status, Appointment.cancelationReason, Appointment.serviceCategory, Appointment.serviceType, Appointment.serviceType.extension, Appointment.serviceType.extension:serviceType, Appointment.serviceType.coding, Appointment.serviceType.text, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.reasonReference, Appointment.priority, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.description, Appointment.supportingInformation, Appointment.start, Appointment.end, Appointment.minutesDuration, Appointment.slot, Appointment.created, Appointment.comment, Appointment.comment.extension, Appointment.comment.extension:note, Appointment.patientInstruction, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.basedOn, Appointment.basedOn.extension, Appointment.basedOn.extension:basedOn, Appointment.basedOn.reference, Appointment.basedOn.type, Appointment.basedOn.identifier, Appointment.basedOn.display, Appointment.participant, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.type, 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.participant.period, Appointment.requestedPeriod | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Appointment.extension, Appointment.extension:class, Appointment.extension:reason, Appointment.extension:replaces, Appointment.extension:virtualService, Appointment.extension:previousAppointment, Appointment.extension:originatingAppointment, Appointment.extension:account, Appointment.extension:cancellationDate, Appointment.extension:subject, Appointment.extension:recurrenceId, Appointment.extension:occurrenceChanged, Appointment.extension:recurrenceTemplate, Appointment.modifierExtension, Appointment.serviceType.extension, Appointment.serviceType.extension:serviceType, Appointment.priority.extension, Appointment.priority.extension:priority, Appointment.comment.extension, Appointment.comment.extension:note, Appointment.patientInstruction.extension, Appointment.patientInstruction.extension:patientInstruction, Appointment.basedOn.extension, Appointment.basedOn.extension:basedOn, Appointment.participant.extension, Appointment.participant.modifierExtension, Appointment.participant.actor.extension, Appointment.participant.actor.extension:actor, Appointment.participant.required.extension, Appointment.participant.required.extension:required | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from Appointment
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
