This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-appointment
Profile of Appointment for use with CPG Implementation Guide
This profile builds on Appointment.
This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | 0..* | |||
workflow-instantiatesCanonical | S | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | S | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | S | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
identifier | S | 1..* | Identifier | |
status | S | 1..1 | code | |
supportingInformation | S | 0..* | Reference(Resource) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 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) | |
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) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
workflow-instantiatesCanonical | SI | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Ids for this item |
status | ?!SΣ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required) |
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) |
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: v2 Appointment Reason Codes (preferred) |
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred) |
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 | |
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | S | 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 | |
patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |
basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible) |
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device |
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required) |
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) |
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 |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | 0..* | |||
workflow-instantiatesCanonical | S | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | S | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | S | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
identifier | S | 1..* | Identifier | |
status | S | 1..1 | code | |
supportingInformation | S | 0..* | Reference(Resource) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | I | 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) | |
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) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
workflow-instantiatesCanonical | SI | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Ids for this item |
status | ?!SΣ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required) |
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) |
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: v2 Appointment Reason Codes (preferred) |
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred) |
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 | |
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |
supportingInformation | S | 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 | |
patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |
basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible) |
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device |
required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required) |
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required) |
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 | Conformance | ValueSet |
Appointment.language | preferred | CommonLanguages Max Binding: AllLanguages |
Appointment.status | required | AppointmentStatus |
Appointment.cancelationReason | example | AppointmentCancellationReason |
Appointment.serviceCategory | example | ServiceCategory |
Appointment.serviceType | example | ServiceType |
Appointment.specialty | preferred | PracticeSettingCodeValueSet |
Appointment.appointmentType | preferred | v2.0276 |
Appointment.reasonCode | preferred | EncounterReasonCodes |
Appointment.participant.type | extensible | ParticipantType |
Appointment.participant.required | required | ParticipantRequired |
Appointment.participant.status | required | ParticipationStatus |
Id | Path | Details | Requirements |
dom-2 | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | 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-3 | 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-6 | Appointment | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
app-4 | 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') | |
app-3 | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-2 | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
ele-1 | Appointment.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Appointment.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Appointment.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Appointment.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Appointment.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Appointment.participant | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
app-1 | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() |