Appointment
Description
Appointments are planned contact moments that patients have with care practitioners. This can for example be an appointment at an outpatient clinic, a follow-up appointment, or a consult by phone. It's also common for procedures such as an MRI or ECG scan to have an appointment. Appointments can lay in the past (completed), in the future (planned), or may have never taken place (cancelled).
Instances
An example of a Condition resource can be found here: Appointment Example 1
Profile
PatientFinderAppointment (Appointment) | I | Appointment | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
specialty | S I | 0..1 | Extension(Reference(Organization)) |
department | S I | 0..1 | Extension(Reference(Organization)) |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ | 0..* | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | S Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
status | S Σ ?! | 1..1 | codeBinding |
cancelationReason | Σ | 0..1 | CodeableConcept |
serviceCategory | Σ | 0..* | CodeableConcept |
serviceType | Σ | 0..* | CodeableConcept |
specialty | Σ | 0..* | CodeableConceptBinding |
appointmentType | S Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
reasonCode | Σ | 0..* | CodeableConceptBinding |
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | |
priority | 0..1 | unsignedInt | |
description | S | 0..1 | string |
supportingInformation | 0..* | Reference(Resource) | |
start | S Σ | 0..1 | instant |
end | S Σ | 0..1 | instant |
minutesDuration | 0..1 | positiveInt | |
slot | 0..* | Reference(Slot) | |
created | 0..1 | dateTime | |
comment | 0..1 | string | |
patientInstruction | 0..1 | string | |
basedOn | 0..* | Reference(ServiceRequest) | |
participant | S I | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | Σ | 0..* | CodeableConceptBinding |
actor | S Σ | 0..1 | Reference(Patient | Practitioner | Location) |
required | Σ | 0..1 | codeBinding |
status | Σ | 1..1 | codeBinding |
period | 0..1 | Period | |
requestedPeriod | 0..* | Period |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="pf-appointment" /> <url value="https://fhir.iqvia.com/patientfinder/StructureDefinition/pf-appointment" /> <name value="PatientFinderAppointment" /> <title value="Appointment" /> <status value="draft" /> <description value="Appointments are planned contact moments that patients have with care practitioners. This can for example be an appointment at an outpatient clinic, a follow-up appointment, or a consult by phone. It's also common for procedures such as an MRI or ECG scan to have an appointment. Appointments can lay in the past (completed), in the future (planned), or may have never taken place (cancelled)." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <name value="FHIR to Patient Finder Mapping" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Appointment" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Appointment" /> <derivation value="constraint" /> <differential> <element id="Appointment.extension"> <path value="Appointment.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> </element> <element id="Appointment.extension:specialty"> <path value="Appointment.extension" /> <sliceName value="specialty" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.iqvia.com/patientfinder/extension/specialism-organization" /> </type> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="(Organization) appointment specialism" /> </mapping> </element> <element id="Appointment.extension:department"> <path value="Appointment.extension" /> <sliceName value="department" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.iqvia.com/patientfinder/extension/department-organization" /> </type> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="(Organization) appointment department" /> </mapping> </element> <element id="Appointment.identifier"> <path value="Appointment.identifier" /> <mustSupport value="true" /> </element> <element id="Appointment.identifier.value"> <path value="Appointment.identifier.value" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="appointment source_id" /> </mapping> </element> <element id="Appointment.status"> <path value="Appointment.status" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="appointment status" /> </mapping> </element> <element id="Appointment.appointmentType"> <path value="Appointment.appointmentType" /> <mustSupport value="true" /> </element> <element id="Appointment.appointmentType.coding.code"> <path value="Appointment.appointmentType.coding.code" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="appointment code" /> </mapping> </element> <element id="Appointment.appointmentType.coding.display"> <path value="Appointment.appointmentType.coding.display" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="appointment type" /> </mapping> </element> <element id="Appointment.description"> <path value="Appointment.description" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="appointment description" /> </mapping> </element> <element id="Appointment.start"> <path value="Appointment.start" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="appointment start date/time" /> </mapping> </element> <element id="Appointment.end"> <path value="Appointment.end" /> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="appointment end date/time" /> </mapping> </element> <element id="Appointment.participant"> <path value="Appointment.participant" /> <mustSupport value="true" /> </element> <element id="Appointment.participant.actor"> <path value="Appointment.participant.actor" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location" /> </type> <mustSupport value="true" /> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="(Patient) the patient taking part in the appointment" /> </mapping> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="(Practitioner) the care provider taking part in the appointment, used for care provider name and care provider position" /> </mapping> <mapping> <identity value="fhir-patient-finder-mapping" /> <map value="(Location) the location where the appointment took place" /> </mapping> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "pf-appointment", "url": "https://fhir.iqvia.com/patientfinder/StructureDefinition/pf-appointment", "name": "PatientFinderAppointment", "title": "Appointment", "status": "draft", "description": "Appointments are planned contact moments that patients have with care practitioners. This can for example be an appointment at an outpatient clinic, a follow-up appointment, or a consult by phone. It's also common for procedures such as an MRI or ECG scan to have an appointment. Appointments can lay in the past (completed), in the future (planned), or may have never taken place (cancelled).\n", "fhirVersion": "4.0.1", "mapping": [ { "identity": "fhir-patient-finder-mapping", "name": "FHIR to Patient Finder Mapping" } ], "kind": "resource", "abstract": false, "type": "Appointment", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment", "derivation": "constraint", "differential": { "element": [ { "id": "Appointment.extension", "path": "Appointment.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "ordered": false, "rules": "open" } }, { "id": "Appointment.extension:specialty", "path": "Appointment.extension", "sliceName": "specialty", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.iqvia.com/patientfinder/extension/specialism-organization" ] } ], "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "(Organization) appointment specialism" } ] }, { "id": "Appointment.extension:department", "path": "Appointment.extension", "sliceName": "department", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.iqvia.com/patientfinder/extension/department-organization" ] } ], "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "(Organization) appointment department" } ] }, { "id": "Appointment.identifier", "path": "Appointment.identifier", "mustSupport": true }, { "id": "Appointment.identifier.value", "path": "Appointment.identifier.value", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "appointment source_id" } ] }, { "id": "Appointment.status", "path": "Appointment.status", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "appointment status" } ] }, { "id": "Appointment.appointmentType", "path": "Appointment.appointmentType", "mustSupport": true }, { "id": "Appointment.appointmentType.coding.code", "path": "Appointment.appointmentType.coding.code", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "appointment code" } ] }, { "id": "Appointment.appointmentType.coding.display", "path": "Appointment.appointmentType.coding.display", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "appointment type" } ] }, { "id": "Appointment.description", "path": "Appointment.description", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "appointment description" } ] }, { "id": "Appointment.start", "path": "Appointment.start", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "appointment start date/time" } ] }, { "id": "Appointment.end", "path": "Appointment.end", "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "appointment end date/time" } ] }, { "id": "Appointment.participant", "path": "Appointment.participant", "mustSupport": true }, { "id": "Appointment.participant.actor", "path": "Appointment.participant.actor", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/Location" ] } ], "mustSupport": true, "mapping": [ { "identity": "fhir-patient-finder-mapping", "map": "(Patient) the patient taking part in the appointment" }, { "identity": "fhir-patient-finder-mapping", "map": "(Practitioner) the care provider taking part in the appointment, used for care provider name and care provider position" }, { "identity": "fhir-patient-finder-mapping", "map": "(Location) the location where the appointment took place" } ] } ] } }
Appointment | |
Definition | 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). |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Appointment.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Appointment.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Appointment.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Appointment.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | 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). |
Invariants |
|
Appointment.text | |
Definition | A human-readable narrative that contains a summary of the resource and can 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | 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 information is added later. |
Invariants |
|
Mappings |
|
Appointment.contained | |
Definition | These 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Appointment.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Appointment.extension:specialty | |
Definition | The organization representing the specialism. |
Cardinality | 0...1 |
Type | Extension(Reference(Organization)) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.extension:department | |
Definition | The organization representing the department. |
Cardinality | 0...1 |
Type | Extension(Reference(Organization)) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.modifierExtension | |
Definition | May 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.identifier | |
Definition | This 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). |
Cardinality | 0...* |
Type | Identifier |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Appointment.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Appointment.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Appointment.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Appointment.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
Appointment.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Appointment.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Appointment.status | |
Definition | The 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. |
Cardinality | 1...1 |
Type | code |
Binding | The free/busy status of an appointment. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.cancelationReason | |
Definition | The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | AppointmentCancellationReason (example) |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.serviceCategory | |
Definition | A broad categorization of the service that is to be performed during this appointment. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | ServiceCategory (example) |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.serviceType | |
Definition | The specific service that is to be performed during this appointment. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | ServiceType (example) |
Summary | True |
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past. |
Invariants |
|
Mappings |
|
Appointment.specialty | |
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | PracticeSettingCodeValueSet (preferred) |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.appointmentType | |
Definition | The style of appointment or patient that has been booked in the slot (not service type). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | v2.0276 (preferred) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.appointmentType.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Appointment.appointmentType.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Appointment.appointmentType.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Appointment.appointmentType.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Appointment.appointmentType.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Appointment.appointmentType.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
Appointment.appointmentType.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Appointment.appointmentType.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Appointment.appointmentType.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Appointment.appointmentType.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Appointment.appointmentType.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Appointment.reasonCode | |
Definition | The coded reason that this appointment is being scheduled. This is more clinical than administrative. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The Reason for the appointment to take place. |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.reasonReference | |
Definition | Reason 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. |
Cardinality | 0...* |
Type | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) |
Invariants |
|
Mappings |
|
Appointment.priority | |
Definition | The 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). |
Cardinality | 0...1 |
Type | unsignedInt |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.description | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Appointment.supportingInformation | |
Definition | Additional information to support the appointment provided when making the appointment. |
Cardinality | 0...* |
Type | Reference(Resource) |
Invariants |
|
Mappings |
|
Appointment.start | |
Definition | Date/Time that the appointment is to take place. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.end | |
Definition | Date/Time that the appointment is to conclude. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.minutesDuration | |
Definition | Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end. |
Cardinality | 0...1 |
Type | positiveInt |
Invariants |
|
Mappings |
|
Appointment.slot | |
Definition | The slots from the participants' schedules that will be filled by the appointment. |
Cardinality | 0...* |
Type | Reference(Slot) |
Invariants |
|
Mappings |
|
Appointment.created | |
Definition | The 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. |
Cardinality | 0...1 |
Type | dateTime |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.comment | |
Definition | Additional comments about the appointment. |
Cardinality | 0...1 |
Type | string |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.patientInstruction | |
Definition | While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before). |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Appointment.basedOn | |
Definition | The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
Cardinality | 0...* |
Type | Reference(ServiceRequest) |
Alias | incomingReferral |
Invariants |
|
Mappings |
|
Appointment.participant | |
Definition | List of participants involved in the appointment. |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Mappings |
|
Appointment.participant.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Appointment.participant.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.participant.modifierExtension | |
Definition | May 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.participant.type | |
Definition | Role of participant in the appointment. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Role of participant in encounter. |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
Appointment.participant.actor | |
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. |
Cardinality | 0...1 |
Type | Reference(Patient | Practitioner | Location) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.participant.required | |
Definition | Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. |
Cardinality | 0...1 |
Type | code |
Binding | Is the Participant required to attend the appointment. |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.participant.status | |
Definition | Participation status of the actor. |
Cardinality | 1...1 |
Type | code |
Binding | The Participation status of an appointment. |
Summary | True |
Invariants |
|
Mappings |
|
Appointment.participant.period | |
Definition | Participation period of the actor. |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Mappings |
|
Appointment.requestedPeriod | |
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system. |
Cardinality | 0...* |
Type | Period |
Comments | This does not introduce a capacity for recurring appointments. |
Invariants |
|
Mappings |
|
Attribute list
Attribute | Description | Example |
---|---|---|
identifier.value | The hospital ID of the patient | 'A12523' |
status | Status of the appointment | 'completed' |
appointmentType.coding.code | An appointment classification code | '11429006' |
description | Description of the appointment | 'Consultation' |
start | Start date/time of the appointment | '2021-01-01T11:00:00Z' |
end | End date/time of the appointment | '2021-01-02T11:00:00Z' |
participant.actor | Patient: Reference to the patient subject of the appointment | 'Patient/patient-1' |
participant.actor | Practitioner: Reference to the care provider of the appointment | 'Practitioner/practitioner-1' |
participant.actor | Location: Reference to the location of the appointment | 'Location/location-1' |