INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Appointment-1
CareConnect Appointment profile.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Appointment-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment | 0..* | Appointment | ||
  identifier | 0..* | Identifier | External Ids for this item. | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 Binding: AppointmentStatus (required) |
| 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) |
| 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) |
 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 | |
| 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 | |
| incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest provided as information to allocate to the Encounter | |
 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible) |
| actor | Σ | 0..1 | Reference(Patient | Practitioner | 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) | |
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| Documentation for this format | ||||
This structure is derived from Appointment
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | 0..* | Appointment | ||
| identifier | 0..* | Identifier | External Ids for this item. | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 Binding: AppointmentStatus (required) |
| 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) |
| 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) |
| 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 | |
| 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 | |
| incomingReferral | 0..* | Reference(ReferralRequest) | The ReferralRequest provided as information to allocate to the Encounter | |
| 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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible) |
| actor | Σ | 0..1 | Reference(Patient | Practitioner | 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) | |
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Appointment.language | extensible | Common Languages Max Binding: All Languages |
| Appointment.status | required | AppointmentStatus |
| Appointment.serviceCategory | example | ServiceCategory |
| Appointment.serviceType | example | ServiceType |
| Appointment.specialty | preferred | Practice Setting Code Value Set |
| Appointment.appointmentType | preferred | v2 Appointment reason codes |
| Appointment.reason | preferred | Encounter Reason Codes |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.required | required | ParticipantRequired |
| Appointment.participant.status | required | ParticipationStatus |
Constraints
Constraints
| 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-1 | Appointment | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| app-3 | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled')) | |
| app-2 | Appointment | Either start and end are specified, or neither : start.empty() xor end.exists() | |
| ele-1 | Appointment.participant | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| app-1 | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() |