Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - 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_R3 | ||
This cross-version profile allows R5 Appointment content to be represented via FHIR STU3 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 | 📍3.0.2 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍3.0.2 | 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.empty() xor 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'))
|
| dom-1 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 | 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-3, app-2 | ||||
  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: Common Languages  (extensible): A human language.
| |||||
| 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 | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:cancellationReason |
0..1 | CodeableConcept | R5: The coded reason for the appointment being cancelled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationReason Binding: R5AppointmentCancellationReasonForR3 (0.1.0) (example) | |||||
| extension:class |
0..* | CodeableConcept | R5: Classification when becoming an encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class | |||||
| extension:reason |
0..* | (Complex) | R5: Reason this appointment is scheduled additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason | |||||
| extension:replaces |
0..* | Reference(Cross-version Profile for R5.Appointment for use in FHIR STU3(0.1.0) | Appointment) | R5: Appointment replaced by this Appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces | |||||
| 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 | |||||
| extension:previousAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR STU3(0.1.0) | Appointment) | R5: The previous appointment in a series (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.previousAppointment | |||||
| extension:originatingAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR STU3(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 | |||||
| extension:account |
0..* | Reference(Cross-version Profile for R5.Account for use in FHIR STU3(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 | |||||
| extension:cancellationDate |
0..1 | dateTime | R5: When the appointment was cancelled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationDate | |||||
| extension:patientInstruction |
0..* | (Complex) | R5: Detailed information and instructions for the patient (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.patientInstruction | |||||
| extension:subject |
0..1 | Reference(Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Group for use in FHIR STU3(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 | |||||
| extension:recurrenceId |
0..1 | positiveInt | R5: The sequence number in the recurrence (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceId | |||||
| 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 | |||||
 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 | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:status |
0..1 | code | R5: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.status Binding: AppointmentStatus (required): The free/busy status of an appointment. | |||||
 value |
0..1 | code | Primitive value for code | |||||
| serviceCategory |
Σ | 0..1 | CodeableConcept | A broad categorisation 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 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:serviceType |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService) | R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.serviceType | |||||
| 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: Practice Setting Code Value Set (preferred) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: v2 Appointment reason codes (preferred) | ||||
| reason |
Σ | 0..* | CodeableConcept | Reason this appointment is scheduled Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place. | ||||
 indication |
0..* | Reference(Condition | Procedure) | Reason the appointment is to takes 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 | |||||
| extension:priority |
0..1 | CodeableConcept | R5: priority additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.priority Binding: ActPriority|2016-11-11 (example): Indicates the urgency of the appointment. | |||||
| 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:supportingInformation |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: supportingInformation additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:slot |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: slot additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | |||||
| extension:note |
0..* | Annotation | R5: note additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| incomingReferral |
0..* | Reference(ReferralRequest) | The ReferralRequest provided as information to allocate to the Encounter | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:basedOn |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: The request this appointment is allocated to assess URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:period |
0..1 | Period | R5: Participation period of the actor (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.period | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
Σ | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:actor |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: The individual, device, location, or service participating in the appointment URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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 | |||||
| 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 | |||||
| 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. | |||||
| 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 | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Appointment.status | Base | required | AppointmentStatus | 📍3.0.2 | FHIR Std. |
| Appointment.serviceCategory | Base | example | ServiceCategory | 📍3.0.2 | FHIR Std. |
| Appointment.serviceType | Base | example | ServiceType | 📍3.0.2 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍20091109 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | v2 Appointment reason codes | 📍2.8.2 | FHIR Std. |
| Appointment.reason | Base | preferred | Encounter Reason Codes | 📍3.0.2 | FHIR Std. |
| Appointment.participant.type | Base | extensible | ParticipantType | 📍3.0.2 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍3.0.2 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍3.0.2 | 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.empty() xor 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'))
|
| dom-1 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 | 📍3.0.2 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍3.0.2 | 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.empty() xor 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'))
|
| dom-1 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 | 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-3, app-2 | ||||
| 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: Common Languages (extensible): A human language.
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:cancellationReason |
0..1 | CodeableConcept | R5: The coded reason for the appointment being cancelled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationReason Binding: R5AppointmentCancellationReasonForR3 (0.1.0) (example) | |||||
| extension:class |
0..* | CodeableConcept | R5: Classification when becoming an encounter (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class | |||||
| extension:reason |
0..* | (Complex) | R5: Reason this appointment is scheduled additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason | |||||
| extension:replaces |
0..* | Reference(Cross-version Profile for R5.Appointment for use in FHIR STU3(0.1.0) | Appointment) | R5: Appointment replaced by this Appointment (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces | |||||
| 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 | |||||
| extension:previousAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR STU3(0.1.0) | Appointment) | R5: The previous appointment in a series (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.previousAppointment | |||||
| extension:originatingAppointment |
0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR STU3(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 | |||||
| extension:account |
0..* | Reference(Cross-version Profile for R5.Account for use in FHIR STU3(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 | |||||
| extension:cancellationDate |
0..1 | dateTime | R5: When the appointment was cancelled (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationDate | |||||
| extension:patientInstruction |
0..* | (Complex) | R5: Detailed information and instructions for the patient (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.patientInstruction | |||||
| extension:subject |
0..1 | Reference(Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Group for use in FHIR STU3(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 | |||||
| extension:recurrenceId |
0..1 | positiveInt | R5: The sequence number in the recurrence (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceId | |||||
| 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 | |||||
| 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 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:status |
0..1 | code | R5: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.status Binding: AppointmentStatus (required): The free/busy status of an appointment. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| serviceCategory |
Σ | 0..1 | CodeableConcept | A broad categorisation 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 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:serviceType |
0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR STU3(0.1.0) | HealthcareService) | R5: serviceType additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.serviceType | |||||
| 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: Practice Setting Code Value Set (preferred) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: v2 Appointment reason codes (preferred) | ||||
| reason |
Σ | 0..* | CodeableConcept | Reason this appointment is scheduled Binding: Encounter Reason Codes (preferred): The Reason for the appointment to take place. | ||||
| indication |
0..* | Reference(Condition | Procedure) | Reason the appointment is to takes 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 | |||||
| extension:priority |
0..1 | CodeableConcept | R5: priority additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.priority Binding: ActPriority|2016-11-11 (example): Indicates the urgency of the appointment. | |||||
| 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:supportingInformation |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: supportingInformation additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:slot |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: slot additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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 | |||||
| extension:note |
0..* | Annotation | R5: note additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| incomingReferral |
0..* | Reference(ReferralRequest) | The ReferralRequest provided as information to allocate to the Encounter | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:basedOn |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: The request this appointment is allocated to assess URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:period |
0..1 | Period | R5: Participation period of the actor (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.period | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
Σ | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:actor |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: The individual, device, location, or service participating in the appointment URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| 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 | |||||
| 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 | |||||
| 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. | |||||
| 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 | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| Appointment.status | Base | required | AppointmentStatus | 📍3.0.2 | FHIR Std. |
| Appointment.serviceCategory | Base | example | ServiceCategory | 📍3.0.2 | FHIR Std. |
| Appointment.serviceType | Base | example | ServiceType | 📍3.0.2 | FHIR Std. |
| Appointment.specialty | Base | preferred | Practice Setting Code Value Set | 📍20091109 | FHIR Std. |
| Appointment.appointmentType | Base | preferred | v2 Appointment reason codes | 📍2.8.2 | FHIR Std. |
| Appointment.reason | Base | preferred | Encounter Reason Codes | 📍3.0.2 | FHIR Std. |
| Appointment.participant.type | Base | extensible | ParticipantType | 📍3.0.2 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍3.0.2 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍3.0.2 | 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.empty() xor 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'))
|
| dom-1 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
