0.3.0 - Second STU ballot

This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v0.3.0: STU 1 Ballot 2) 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

StructureDefinition: AppointmentR4

The official URL for this profile is: 

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

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 I0..*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..1idLogical 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
... 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 SI0..*Reference(CoverageR4)Insurance
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..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
... 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: v2 Appointment Reason Codes (preferred)
... reasonCode Σ0..*CodeableConceptCoded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred)
... 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(ServiceRequestR4)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)
.... actor SΣ0..1Reference(PatientR4 | PractitionerR4 | LocationR4)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
.... 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

This structure is derived from Appointment

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*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..1idLogical 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
... 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 SI0..*Reference(CoverageR4)Insurance
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..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
... 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: v2 Appointment Reason Codes (preferred)
... reasonCode Σ0..*CodeableConceptCoded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred)
... 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(ServiceRequestR4)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)
.... actor SΣ0..1Reference(PatientR4 | PractitionerR4 | LocationR4)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status SΣ1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
.... 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.statusrequiredAppointmentStatus
Appointment.serviceCategoryexampleServiceCategory
Appointment.serviceTypeexampleServiceType
Appointment.specialtypreferredPracticeSettingCodeValueSet
Appointment.appointmentTypepreferredv2.0276
Appointment.participant.statusrequiredParticipationStatus

Constraints

IdPathDetailsRequirements
dom-2AppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.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-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-6AppointmentA resource should have narrative for robust management
: text.div.exists()
dom-5AppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
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')
app-3AppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-2AppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
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.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.participantAll 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()