CareConnect Appointment profile.
CareConnect-Appointment-1 (Appointment) | I | Appointment | There are no (further) constraints on this element Element idAppointment 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) DefinitionA 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 | There are no (further) constraints on this element Element idAppointment.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointment.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointment.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Common Languages (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointment.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idAppointment.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
| |
extension | 0..* | Extension | Element idAppointment.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Mappings
| |
deliveryChannel | I | 0..1 | Extension(code) | Element idAppointment.extension:deliveryChannel An extension to record the delivery channel of a scheduled Appointment Alternate namesextensions, user content DefinitionAn extension to record the delivery channel of a scheduled Appointment. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeliveryChannel-1 Constraints
|
appointmentCancellationReason | I | 0..1 | Extension(string) | Element idAppointment.extension:appointmentCancellationReason The reason the appointment was cancelled Alternate namesextensions, user content DefinitionThe reason the appointment was cancelled. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
bookingOrganisation | I | 0..1 | Extension(Reference(CareConnect-Organization-1)) | Element idAppointment.extension:bookingOrganisation An extension to record the organisation booking the appointment Alternate namesextensions, user content DefinitionAn extension to record the organisation booking the appointment. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Reference(CareConnect-Organization-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-BookingOrganisation-1 Constraints
|
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
identifier | Σ | 0..* | Identifier | Element idAppointment.identifier External Ids for this item. DefinitionThis records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.status proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error DefinitionThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. The free/busy status of an appointment. AppointmentStatus (required)Mappings
|
serviceCategory | Σ | 0..1 | CodeableConceptBinding | Element idAppointment.serviceCategory A broad categorisation of the service that is to be performed during this appointment DefinitionA broad categorisation of the service that is to be performed during this appointment. A ValueSet that contains a set of codes that identify the Practitioner of a scheduled Appointment. Care Connect SDS Job Role Name (extensible)Mappings
|
serviceType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceType The specific service that is to be performed during this appointment DefinitionThe specific service that is to be performed during this appointment.
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.specialty The specialty of a practitioner that would be required to perform the service requested in this appointment DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment. Practice Setting Code Value Set (preferred) Mappings
|
appointmentType | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.appointmentType The style of appointment or patient that has been booked in the slot (not service type) DefinitionThe style of appointment or patient that has been booked in the slot (not service type). v2 Appointment reason codes (preferred) Mappings
|
reason | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.reason Reason this appointment is scheduled DefinitionThe reason that this appointment is being scheduled. This is more clinical than administrative. The Reason for the appointment to take place. Encounter Reason Codes (preferred)Mappings
|
indication | 0..* | Reference(Condition | Procedure) | There are no (further) constraints on this element Element idAppointment.indication Reason the appointment is to takes place (resource) DefinitionReason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. Reference(Condition | Procedure) Mappings
| |
priority | 0..1 | unsignedInt | There are no (further) constraints on this element Element idAppointment.priority Used to make informed decisions if needing to re-prioritize DefinitionThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority). Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a codeableconcept for named values may be tested at a future connectathon.
| |
description | 0..1 | string | There are no (further) constraints on this element Element idAppointment.description Shown on a subject line in a meeting request, or appointment list DefinitionThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
| |
supportingInformation | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idAppointment.supportingInformation Additional information to support the appointment DefinitionAdditional information to support the appointment provided when making the appointment.
| |
start | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.start When appointment is to take place DefinitionDate/Time that the appointment is to take place.
|
end | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.end When appointment is to conclude DefinitionDate/Time that the appointment is to conclude.
|
minutesDuration | 0..1 | positiveInt | There are no (further) constraints on this element Element idAppointment.minutesDuration Can be less than start/end (e.g. estimate) DefinitionNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
| |
slot | 0..* | Reference(Slot) | There are no (further) constraints on this element Element idAppointment.slot The slots that this appointment is filling DefinitionThe slots from the participants' schedules that will be filled by the appointment.
| |
created | 0..1 | dateTime | There are no (further) constraints on this element Element idAppointment.created The date that this appointment was initially created DefinitionThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
| |
comment | 0..1 | string | There are no (further) constraints on this element Element idAppointment.comment Additional comments DefinitionAdditional comments about the appointment. Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.
| |
incomingReferral | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idAppointment.incomingReferral The ReferralRequest provided as information to allocate to the Encounter DefinitionThe referral request this appointment is allocated to assess (incoming referral).
| |
participant | I | 1..* | BackboneElement | There are no (further) constraints on this element Element idAppointment.participant Participants involved in appointment DefinitionList of participants involved in the appointment.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.participant.type Role of participant in the appointment DefinitionRole of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. Role of participant in encounter. ParticipantType (extensible)Mappings
|
actor | Σ | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) | There are no (further) constraints on this element Element idAppointment.participant.actor Person, Location/HealthcareService or Device DefinitionA Person, Location/HealthcareService or Device that is participating in the appointment. Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Mappings
|
required | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.required required | optional | information-only DefinitionIs this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. Is the Participant required to attend the appointment. ParticipantRequired (required)Mappings
|
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.status accepted | declined | tentative | needs-action DefinitionParticipation status of the actor. The Participation status of an appointment. ParticipationStatus (required)Mappings
| |
requestedPeriod | 0..* | Period | There are no (further) constraints on this element Element idAppointment.requestedPeriod Potential date/time interval(s) requested to allocate the appointment within DefinitionA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. This does not introduce a capacity for recurring appointments.
|
CareConnect-Appointment-1 (Appointment) | I | Appointment | There are no (further) constraints on this element Element idAppointment 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) DefinitionA 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 | There are no (further) constraints on this element Element idAppointment.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointment.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointment.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Common Languages (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointment.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idAppointment.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
| |
extension | 0..* | Extension | Element idAppointment.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Mappings
| |
deliveryChannel | I | 0..1 | Extension(code) | Element idAppointment.extension:deliveryChannel An extension to record the delivery channel of a scheduled Appointment Alternate namesextensions, user content DefinitionAn extension to record the delivery channel of a scheduled Appointment. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeliveryChannel-1 Constraints
|
appointmentCancellationReason | I | 0..1 | Extension(string) | Element idAppointment.extension:appointmentCancellationReason The reason the appointment was cancelled Alternate namesextensions, user content DefinitionThe reason the appointment was cancelled. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
bookingOrganisation | I | 0..1 | Extension(Reference(CareConnect-Organization-1)) | Element idAppointment.extension:bookingOrganisation An extension to record the organisation booking the appointment Alternate namesextensions, user content DefinitionAn extension to record the organisation booking the appointment. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Reference(CareConnect-Organization-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-BookingOrganisation-1 Constraints
|
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
identifier | Σ | 0..* | Identifier | Element idAppointment.identifier External Ids for this item. DefinitionThis records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.status proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error DefinitionThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. The free/busy status of an appointment. AppointmentStatus (required)Mappings
|
serviceCategory | Σ | 0..1 | CodeableConceptBinding | Element idAppointment.serviceCategory A broad categorisation of the service that is to be performed during this appointment DefinitionA broad categorisation of the service that is to be performed during this appointment. A ValueSet that contains a set of codes that identify the Practitioner of a scheduled Appointment. Care Connect SDS Job Role Name (extensible)Mappings
|
serviceType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceType The specific service that is to be performed during this appointment DefinitionThe specific service that is to be performed during this appointment.
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.specialty The specialty of a practitioner that would be required to perform the service requested in this appointment DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment. Practice Setting Code Value Set (preferred) Mappings
|
appointmentType | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.appointmentType The style of appointment or patient that has been booked in the slot (not service type) DefinitionThe style of appointment or patient that has been booked in the slot (not service type). v2 Appointment reason codes (preferred) Mappings
|
reason | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.reason Reason this appointment is scheduled DefinitionThe reason that this appointment is being scheduled. This is more clinical than administrative. The Reason for the appointment to take place. Encounter Reason Codes (preferred)Mappings
|
indication | 0..* | Reference(Condition | Procedure) | There are no (further) constraints on this element Element idAppointment.indication Reason the appointment is to takes place (resource) DefinitionReason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. Reference(Condition | Procedure) Mappings
| |
priority | 0..1 | unsignedInt | There are no (further) constraints on this element Element idAppointment.priority Used to make informed decisions if needing to re-prioritize DefinitionThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority). Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a codeableconcept for named values may be tested at a future connectathon.
| |
description | 0..1 | string | There are no (further) constraints on this element Element idAppointment.description Shown on a subject line in a meeting request, or appointment list DefinitionThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
| |
supportingInformation | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idAppointment.supportingInformation Additional information to support the appointment DefinitionAdditional information to support the appointment provided when making the appointment.
| |
start | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.start When appointment is to take place DefinitionDate/Time that the appointment is to take place.
|
end | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.end When appointment is to conclude DefinitionDate/Time that the appointment is to conclude.
|
minutesDuration | 0..1 | positiveInt | There are no (further) constraints on this element Element idAppointment.minutesDuration Can be less than start/end (e.g. estimate) DefinitionNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
| |
slot | 0..* | Reference(Slot) | There are no (further) constraints on this element Element idAppointment.slot The slots that this appointment is filling DefinitionThe slots from the participants' schedules that will be filled by the appointment.
| |
created | 0..1 | dateTime | There are no (further) constraints on this element Element idAppointment.created The date that this appointment was initially created DefinitionThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
| |
comment | 0..1 | string | There are no (further) constraints on this element Element idAppointment.comment Additional comments DefinitionAdditional comments about the appointment. Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.
| |
incomingReferral | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idAppointment.incomingReferral The ReferralRequest provided as information to allocate to the Encounter DefinitionThe referral request this appointment is allocated to assess (incoming referral).
| |
participant | I | 1..* | BackboneElement | There are no (further) constraints on this element Element idAppointment.participant Participants involved in appointment DefinitionList of participants involved in the appointment.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.participant.type Role of participant in the appointment DefinitionRole of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. Role of participant in encounter. ParticipantType (extensible)Mappings
|
actor | Σ | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) | There are no (further) constraints on this element Element idAppointment.participant.actor Person, Location/HealthcareService or Device DefinitionA Person, Location/HealthcareService or Device that is participating in the appointment. Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Mappings
|
required | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.required required | optional | information-only DefinitionIs this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. Is the Participant required to attend the appointment. ParticipantRequired (required)Mappings
|
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.status accepted | declined | tentative | needs-action DefinitionParticipation status of the actor. The Participation status of an appointment. ParticipationStatus (required)Mappings
| |
requestedPeriod | 0..* | Period | There are no (further) constraints on this element Element idAppointment.requestedPeriod Potential date/time interval(s) requested to allocate the appointment within DefinitionA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. This does not introduce a capacity for recurring appointments.
|
CareConnect-Appointment-1 (Appointment) | I | Appointment | There are no (further) constraints on this element Element idAppointment 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) DefinitionA 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 | There are no (further) constraints on this element Element idAppointment.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointment.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointment.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. Common Languages (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointment.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idAppointment.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
| |
extension | 0..* | Extension | Element idAppointment.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Mappings
| |
deliveryChannel | I | 0..1 | Extension(code) | Element idAppointment.extension:deliveryChannel An extension to record the delivery channel of a scheduled Appointment Alternate namesextensions, user content DefinitionAn extension to record the delivery channel of a scheduled Appointment. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeliveryChannel-1 Constraints
|
appointmentCancellationReason | I | 0..1 | Extension(string) | Element idAppointment.extension:appointmentCancellationReason The reason the appointment was cancelled Alternate namesextensions, user content DefinitionThe reason the appointment was cancelled. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
bookingOrganisation | I | 0..1 | Extension(Reference(CareConnect-Organization-1)) | Element idAppointment.extension:bookingOrganisation An extension to record the organisation booking the appointment Alternate namesextensions, user content DefinitionAn extension to record the organisation booking the appointment. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Extension(Reference(CareConnect-Organization-1)) Extension URLhttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-BookingOrganisation-1 Constraints
|
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
identifier | Σ | 0..* | Identifier | Element idAppointment.identifier External Ids for this item. DefinitionThis records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.status proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error DefinitionThe overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. The free/busy status of an appointment. AppointmentStatus (required)Mappings
|
serviceCategory | Σ | 0..1 | CodeableConceptBinding | Element idAppointment.serviceCategory A broad categorisation of the service that is to be performed during this appointment DefinitionA broad categorisation of the service that is to be performed during this appointment. A ValueSet that contains a set of codes that identify the Practitioner of a scheduled Appointment. Care Connect SDS Job Role Name (extensible)Mappings
|
serviceType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceType The specific service that is to be performed during this appointment DefinitionThe specific service that is to be performed during this appointment.
|
specialty | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.specialty The specialty of a practitioner that would be required to perform the service requested in this appointment DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment. Practice Setting Code Value Set (preferred) Mappings
|
appointmentType | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.appointmentType The style of appointment or patient that has been booked in the slot (not service type) DefinitionThe style of appointment or patient that has been booked in the slot (not service type). v2 Appointment reason codes (preferred) Mappings
|
reason | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.reason Reason this appointment is scheduled DefinitionThe reason that this appointment is being scheduled. This is more clinical than administrative. The Reason for the appointment to take place. Encounter Reason Codes (preferred)Mappings
|
indication | 0..* | Reference(Condition | Procedure) | There are no (further) constraints on this element Element idAppointment.indication Reason the appointment is to takes place (resource) DefinitionReason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure. Reference(Condition | Procedure) Mappings
| |
priority | 0..1 | unsignedInt | There are no (further) constraints on this element Element idAppointment.priority Used to make informed decisions if needing to re-prioritize DefinitionThe priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority). Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a codeableconcept for named values may be tested at a future connectathon.
| |
description | 0..1 | string | There are no (further) constraints on this element Element idAppointment.description Shown on a subject line in a meeting request, or appointment list DefinitionThe brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
| |
supportingInformation | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idAppointment.supportingInformation Additional information to support the appointment DefinitionAdditional information to support the appointment provided when making the appointment.
| |
start | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.start When appointment is to take place DefinitionDate/Time that the appointment is to take place.
|
end | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.end When appointment is to conclude DefinitionDate/Time that the appointment is to conclude.
|
minutesDuration | 0..1 | positiveInt | There are no (further) constraints on this element Element idAppointment.minutesDuration Can be less than start/end (e.g. estimate) DefinitionNumber of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
| |
slot | 0..* | Reference(Slot) | There are no (further) constraints on this element Element idAppointment.slot The slots that this appointment is filling DefinitionThe slots from the participants' schedules that will be filled by the appointment.
| |
created | 0..1 | dateTime | There are no (further) constraints on this element Element idAppointment.created The date that this appointment was initially created DefinitionThe date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment. This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
| |
comment | 0..1 | string | There are no (further) constraints on this element Element idAppointment.comment Additional comments DefinitionAdditional comments about the appointment. Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.
| |
incomingReferral | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idAppointment.incomingReferral The ReferralRequest provided as information to allocate to the Encounter DefinitionThe referral request this appointment is allocated to assess (incoming referral).
| |
participant | I | 1..* | BackboneElement | There are no (further) constraints on this element Element idAppointment.participant Participants involved in appointment DefinitionList of participants involved in the appointment.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
| |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.participant.type Role of participant in the appointment DefinitionRole of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. Role of participant in encounter. ParticipantType (extensible)Mappings
|
actor | Σ | 0..1 | Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) | There are no (further) constraints on this element Element idAppointment.participant.actor Person, Location/HealthcareService or Device DefinitionA Person, Location/HealthcareService or Device that is participating in the appointment. Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Mappings
|
required | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.required required | optional | information-only DefinitionIs this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. Is the Participant required to attend the appointment. ParticipantRequired (required)Mappings
|
status | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.status accepted | declined | tentative | needs-action DefinitionParticipation status of the actor. The Participation status of an appointment. ParticipationStatus (required)Mappings
| |
requestedPeriod | 0..* | Period | There are no (further) constraints on this element Element idAppointment.requestedPeriod Potential date/time interval(s) requested to allocate the appointment within DefinitionA set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. This does not introduce a capacity for recurring appointments.
|
Appointment | .. | |
Appointment.extension | 0.. | |
Appointment.extension | Extension | 0.. |
Appointment.extension | Extension | 0.. |
Appointment.extension | Extension | 0.. |
Appointment.identifier | .. | |
Appointment.serviceCategory | .. |
There is no specific guidance for this profile.