Visiba Care Fhir Implementation Guide - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: Visiba Appointment Profile
| Official URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-profile | Version: 0.2.0 | |||
| Active as of 2022-04-13 | Computable Name: AppointmentProfile | |||
Defines extensions on the Appointment resource.
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment | 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) | |
  participant | ||||
   AppointmentTicketExtension | 0..1 | uri | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-ticket-extension | |
 AppointmentParticipantIdExtension | 0..1 | string | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-participant-id-extension | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
 participant | C | 1..* | BackboneElement | Participants involved in appointment |
| AppointmentTicketExtension | 0..1 | uri | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-ticket-extension | |
| AppointmentParticipantIdExtension | 0..1 | string | Optional Extensions Element URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-participant-id-extension | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Appointment.status | required | AppointmentStatus |
| Appointment.participant.status | required | ParticipationStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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 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-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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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) | ||||
| 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | 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) | ||||
| 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: hl7VS-appointmentReasonCodes (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 | |||||
| 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 | |||||
| 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 | C | 1..* | BackboneElement | Participants involved in appointment | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| AppointmentTicketExtension | 0..1 | uri | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-ticket-extension | |||||
| AppointmentParticipantIdExtension | 0..1 | string | Optional Extensions Element URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-participant-id-extension | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | ||||
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| Appointment.status | required | AppointmentStatus | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReason | ||||
| Appointment.serviceCategory | example | ServiceCategory | ||||
| Appointment.serviceType | example | ServiceType | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (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
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | 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) | |
| participant | ||||
| AppointmentTicketExtension | 0..1 | uri | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-ticket-extension | |
| AppointmentParticipantIdExtension | 0..1 | string | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-participant-id-extension | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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. |
| participant | C | 1..* | BackboneElement | Participants involved in appointment |
| AppointmentTicketExtension | 0..1 | uri | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-ticket-extension | |
| AppointmentParticipantIdExtension | 0..1 | string | Optional Extensions Element URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-participant-id-extension | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Appointment.status | required | AppointmentStatus |
| Appointment.participant.status | required | ParticipationStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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 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-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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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) | ||||
| 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | 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) | ||||
| 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: hl7VS-appointmentReasonCodes (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 | |||||
| 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 | |||||
| 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 | C | 1..* | BackboneElement | Participants involved in appointment | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| AppointmentTicketExtension | 0..1 | uri | Extension URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-ticket-extension | |||||
| AppointmentParticipantIdExtension | 0..1 | string | Optional Extensions Element URL: https://schema.visibacare.com/fhir/StructureDefinition/appointment-participant-id-extension | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | ||||
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| 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 | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| Appointment.status | required | AppointmentStatus | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReason | ||||
| Appointment.serviceCategory | example | ServiceCategory | ||||
| Appointment.serviceType | example | ServiceType | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (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
Other representations of profile: CSV, Excel, Schematron