Da Vinci - Coverage Requirements Discovery
1.0.0 - STU 1

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Appointment

Defining URL:http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment
Version:1.0.0
Name:Appointment
Status:Draft as of 2018-07-25
Definition:

This profile specifies extensions and constraints on the Appointment resource to support coverage requirements discovery.

Publisher:HL7 International - Financial Management Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-appointment

Usage


CRD Clients SHALL use this profile to provide appointments context objects to CRD Services when invoking the appointment-book hook as well as to resolve other references to Appointment resources.

Information provided in Must Support elements will commonly be required for CRD Services to perform coverage requirements discovery.

The insurance extension (ext-insurance) allows relevant coverage information to be conveyed with a proposed Appointment. A search parameter is defined in this guide to enable the prefetch of coverage information when invoking hooks.

Formal Views of Profile Content

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

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment 0..*AppointmentA 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)
... ext-insurance S0..*Reference(Coverage)Coverage relevant to the request
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-insurance
... identifier S0..*IdentifierExternal Ids for this item
... status S1..1codeAppointment status
Example General: proposed
... serviceType S0..*CodeableConceptThe specific service that is to be performed during this appointment
... specialty S0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
... appointmentType S0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
... reasonReference S0..*Reference(US Core Condition Profile | Procedure)Reason the appointment is to take place (resource)
... start S1..1instantWhen appointment is to take place
... end S1..1instantWhen appointment is to conclude
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant S1..*BackboneElementParticipants involved in appointment
.... actor S0..1Reference(Patient | Practitioner | Location)Patient, Practitioner or Location
.... status S1..1codeaccepted | declined | tentative | needs-action
... requestedPeriod S1..1PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-insurance S0..*Reference(Coverage)Coverage relevant to the request
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-insurance
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this item
... status ?!SΣ1..1codeAppointment status
Binding: AppointmentStatus (required): The free/busy status of an appointment.


Example General: proposed
... cancelationReason Σ0..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory SΣ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty SΣ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType SΣ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ0..*CodeableConceptCoded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.


... reasonReference S0..*Reference(US Core Condition Profile | Procedure)Reason the appointment is to take place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource)Additional information to support the appointment
... start SΣ1..1instantWhen appointment is to take place
... end SΣ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction 0..1stringDetailed information and instructions for the patient
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant SI1..*BackboneElementParticipants involved in appointment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor SΣ0..1Reference(Patient | Practitioner | Location)Patient, Practitioner or Location
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod S1..1PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA 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)
... ext-insurance 0..*Reference(Coverage)Coverage relevant to the request
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-insurance
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!Σ1..1codeAppointment status
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... serviceType Σ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonReference 0..*Reference(US Core Condition Profile | Procedure)Reason the appointment is to take place (resource)
... start Σ1..1instantWhen appointment is to take place
... end Σ1..1instantWhen appointment is to conclude
... participant I1..*BackboneElementParticipants involved in appointment
.... actor Σ0..1Reference(Patient | Practitioner | Location)Patient, Practitioner or Location
.... status Σ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

... requestedPeriod 1..1PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment 0..*AppointmentA 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)
... ext-insurance S0..*Reference(Coverage)Coverage relevant to the request
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-insurance
... identifier S0..*IdentifierExternal Ids for this item
... status S1..1codeAppointment status
Example General: proposed
... serviceType S0..*CodeableConceptThe specific service that is to be performed during this appointment
... specialty S0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
... appointmentType S0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
... reasonReference S0..*Reference(US Core Condition Profile | Procedure)Reason the appointment is to take place (resource)
... start S1..1instantWhen appointment is to take place
... end S1..1instantWhen appointment is to conclude
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant S1..*BackboneElementParticipants involved in appointment
.... actor S0..1Reference(Patient | Practitioner | Location)Patient, Practitioner or Location
.... status S1..1codeaccepted | declined | tentative | needs-action
... requestedPeriod S1..1PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*AppointmentA 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..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-insurance S0..*Reference(Coverage)Coverage relevant to the request
URL: http://hl7.org/fhir/us/davinci-crd/StructureDefinition/ext-insurance
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this item
... status ?!SΣ1..1codeAppointment status
Binding: AppointmentStatus (required): The free/busy status of an appointment.


Example General: proposed
... cancelationReason Σ0..1CodeableConceptThe coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory SΣ0..*CodeableConceptA broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty SΣ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType SΣ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ0..*CodeableConceptCoded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.


... reasonReference S0..*Reference(US Core Condition Profile | Procedure)Reason the appointment is to take place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource)Additional information to support the appointment
... start SΣ1..1instantWhen appointment is to take place
... end SΣ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... patientInstruction 0..1stringDetailed information and instructions for the patient
... basedOn 0..*Reference(ServiceRequest)The service request this appointment is allocated to assess
... participant SI1..*BackboneElementParticipants involved in appointment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.


.... actor SΣ0..1Reference(Patient | Practitioner | Location)Patient, Practitioner or Location
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.

.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

.... period 0..1PeriodParticipation period of the actor
... requestedPeriod S1..1PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Appointment.languagepreferredCommonLanguages
Max Binding: AllLanguages
Appointment.statusrequiredAppointmentStatus
Appointment.cancelationReasonexampleAppointmentCancellationReason
Appointment.serviceCategoryexampleServiceCategory
Appointment.serviceTypeexampleServiceType
Appointment.specialtypreferredPracticeSettingCodeValueSet
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
Appointment.reasonCodepreferredEncounterReasonCodes
Appointment.participant.typeextensibleParticipantType
Appointment.participant.requiredrequiredParticipantRequired
Appointment.participant.statusrequiredParticipationStatus

Constraints

IdPathDetailsRequirements
app-2AppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3AppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4AppointmentCancelation 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-2AppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3AppointmentIf 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-4AppointmentIf 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-5AppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6AppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1Appointment.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.extension:CRD-InsuranceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.extension:CRD-InsuranceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.cancelationReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceCategoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.serviceTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.specialtyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.appointmentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.supportingInformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.startAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.endAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.minutesDurationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.slotAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.createdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.commentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.patientInstructionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.basedOnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
app-1Appointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
ele-1Appointment.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Appointment.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Appointment.participant.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.requiredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.participant.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Appointment.requestedPeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())