This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.0.1: STU 2.0) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the profile-appointment resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Appointment | |
2. Appointment.extension | |
Slicing | This element introduces a set of slices on Appointment.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
4. Appointment.extension:Coverage-Information | |
Slice Name | Coverage-Information |
Short | Coverage Info |
Control | 0..* |
Type | Extension(Coverage Information) (Complex Extension) |
Must Support | true |
6. Appointment.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
8. Appointment.status | |
Short | Appointment status |
Must Support | true |
Example | <br/><b>General</b>:proposed |
10. Appointment.serviceCategory | |
Must Support | true |
12. Appointment.serviceType | |
Must Support | true |
14. Appointment.specialty | |
Must Support | true |
16. Appointment.appointmentType | |
Must Support | true |
18. Appointment.reasonReference | |
Comments | potentially relevant for CRD in some situations. |
Type | Reference(US Core Condition Profile, Procedure) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
20. Appointment.start | |
Control | 1..? |
Must Support | true |
22. Appointment.end | |
Control | 1..? |
Must Support | true |
24. Appointment.basedOn | |
Comments | potentially relevant for CRD in some situations. |
Type | Reference(CRD Service Request) |
26. Appointment.participant | |
Must Support | true |
28. Appointment.participant.actor | |
Short | Patient, Practitioner or Location |
Type | Reference(CRD Patient, CRD Practitioner, CRD Location) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
30. Appointment.participant.status | |
Must Support | true |
32. Appointment.requestedPeriod | |
Control | 1..1 |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. 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). |
Short | 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) |
Control | 0..* |
Is Modifier | false |
Summary | false |
Invariants | app-2: Either start and end are specified, or neither (start.exists() = end.exists() )app-3: Only proposed or cancelled appointments can be missing start/end dates ( (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) )app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show ( Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) app-2: Either start and end are specified, or neither (start.exists() = end.exists()) app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))) app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show (Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')) |
2. 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. |
Short | A set of rules under which this content was created |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Appointment.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Appointment.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
6. Appointment.extension:Coverage-Information | |
Slice Name | Coverage-Information |
Definition | Indicates coverage information. |
Short | Coverage Info |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension(Coverage Information) (Complex Extension) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )crd-ci-q1: Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc' ( extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc')) )crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' should not exist. ( extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists() )crd-ci-q3: If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'. ( extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 )crd-ci-q4: If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'. ( extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA') )crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. ( extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists() ) |
8. 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). |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
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. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
10. 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). |
Short | External Ids for this item |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. 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. |
Short | Appointment statusproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist |
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. |
Control | 1..1 |
Binding | The codes SHALL be taken from AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 The free/busy status of an appointment. |
Type | code |
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Example | <br/><b>General</b>:proposed |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. Appointment.serviceCategory | |
Definition | A broad categorization of the service that is to be performed during this appointment. |
Short | A broad categorization of the service that is to be performed during this appointment |
Control | 0..* |
Binding | For example codes, see ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Appointment.serviceType | |
Definition | The specific service that is to be performed during this appointment. |
Short | The specific service that is to be performed during this appointment |
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. |
Control | 0..* |
Binding | For example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Appointment.specialty | |
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. |
Short | The specialty of a practitioner that would be required to perform the service requested in this appointment |
Control | 0..* |
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Appointment.appointmentType | |
Definition | The style of appointment or patient that has been booked in the slot (not service type). |
Short | The style of appointment or patient that has been booked in the slot (not service type) |
Control | 0..1 |
Binding | The codes SHOULD be taken from hl7VS-appointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. 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. |
Short | Reason the appointment is to take place (resource) |
Comments | potentially relevant for CRD in some situations. |
Control | 0..* |
Type | Reference(US Core Condition Profile, Procedure, Condition, Observation, ImmunizationRecommendation) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Appointment.start | |
Definition | Date/Time that the appointment is to take place. |
Short | When appointment is to take place |
Control | 10..1 |
Type | instant |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. Appointment.end | |
Definition | Date/Time that the appointment is to conclude. |
Short | When appointment is to conclude |
Control | 10..1 |
Type | instant |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. Appointment.basedOn | |
Definition | The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
Short | The service request this appointment is allocated to assess |
Comments | potentially relevant for CRD in some situations. |
Control | 0..* |
Type | Reference(CRD Service Request, ServiceRequest) |
Is Modifier | false |
Summary | false |
Alternate Names | incomingReferral |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. Appointment.participant | |
Definition | List of participants involved in the appointment. |
Short | Participants involved in appointment |
Control | 1..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists() )ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists()) |
32. 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
34. Appointment.participant.actor | |
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. |
Short | Patient, Practitioner or LocationPerson, Location/HealthcareService or Device |
Control | 0..1 |
Type | Reference(CRD Patient, CRD Practitioner, CRD Location, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Appointment.participant.status | |
Definition | Participation status of the actor. |
Short | accepted | declined | tentative | needs-action |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1 The Participation status of an appointment. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. 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. |
Short | Potential date/time interval(s) requested to allocate the appointment within |
Comments | This does not introduce a capacity for recurring appointments. |
Control | 10..1* |
Type | Period |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. 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). | ||||
Short | 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) | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | app-2: Either start and end are specified, or neither (start.exists() = end.exists() )app-3: Only proposed or cancelled appointments can be missing start/end dates ( (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) )app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show ( Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') )dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources ( contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() ) | ||||
2. Appointment.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. 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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. 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. | ||||
Short | A set of rules under which this content was created | ||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. Appointment.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. 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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. 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. | ||||
Short | Contained, inline 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. Appointment.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Appointment.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
16. Appointment.extension:Coverage-Information | |||||
Slice Name | Coverage-Information | ||||
Definition | Indicates coverage information. | ||||
Short | Coverage Info | ||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Coverage Information) (Complex Extension) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() )crd-ci-q1: Questionnaire and QuestionnaireResponse are only allowed when doc-needed exists and not equal to 'no-doc' ( extension.where(url='questionnaire' or url='response').exists() implies (extension.where(url = 'doc-needed').exists() and extension.where(url = 'doc-needed').all(value != 'no-doc')) )crd-ci-q2: If covered is set to 'not-covered', then 'pa-needed' should not exist. ( extension.where(url = 'covered' and value != 'not-covered') implies extension.where(url = 'pa-needed').exists() )crd-ci-q3: If 'info-needed' exists, then at least one of 'covered', 'pa-needed', or 'doc-needed' must be 'conditional'. ( extension.where(url = 'info-needed').exists() implies extension.where((url = 'covered' or url = 'pa-needed' or url = 'doc-needed') and value = 'conditional').count() >= 1 )crd-ci-q4: If 'pa-needed' is 'satisfied', then 'Doc-purpose' can't be 'PA'. ( extension.where(url = 'pa-needed' and value = 'satisfied') and extension.where(url = 'doc-purpose').exists() implies extension.where(url = 'doc-purpose').all(value != 'PA') )crd-ci-q5: 'satisfied-pa-id' must exist if and only if 'pa-needed' is set to 'satisfied'. ( extension.where(url = 'pa-needed' and value = 'satisfied').exists() = extension.where(url = 'satisfied-pa-id').exists() ) | ||||
18. 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). | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
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. | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
20. 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). | ||||
Short | External Ids for this item | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
22. 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. | ||||
Short | Appointment status | ||||
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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from AppointmentStatus The free/busy status of an appointment. | ||||
Type | code | ||||
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Example | <br/><b>General</b>:proposed | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. 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. | ||||
Short | The coded reason for the appointment being cancelled | ||||
Control | 0..1 | ||||
Binding | For example codes, see AppointmentCancellationReason | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. Appointment.serviceCategory | |||||
Definition | A broad categorization of the service that is to be performed during this appointment. | ||||
Short | A broad categorization of the service that is to be performed during this appointment | ||||
Control | 0..* | ||||
Binding | For example codes, see ServiceCategory | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. Appointment.serviceType | |||||
Definition | The specific service that is to be performed during this appointment. | ||||
Short | The specific service that is to be performed during this appointment | ||||
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. | ||||
Control | 0..* | ||||
Binding | For example codes, see ServiceType | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. Appointment.specialty | |||||
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. | ||||
Short | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. Appointment.appointmentType | |||||
Definition | The style of appointment or patient that has been booked in the slot (not service type). | ||||
Short | The style of appointment or patient that has been booked in the slot (not service type) | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from hl7VS-appointmentReasonCodes | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. Appointment.reasonCode | |||||
Definition | The coded reason that this appointment is being scheduled. This is more clinical than administrative. | ||||
Short | Coded reason this appointment is scheduled | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from EncounterReasonCodes The Reason for the appointment to take place. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. 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. | ||||
Short | Reason the appointment is to take place (resource) | ||||
Comments | potentially relevant for CRD in some situations. | ||||
Control | 0..* | ||||
Type | Reference(US Core Condition Profile, Procedure) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. 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). | ||||
Short | Used to make informed decisions if needing to re-prioritize | ||||
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. | ||||
Control | 0..1 | ||||
Type | unsignedInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. 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. | ||||
Short | Shown on a subject line in a meeting request, or appointment list | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. Appointment.supportingInformation | |||||
Definition | Additional information to support the appointment provided when making the appointment. | ||||
Short | Additional information to support the appointment | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. Appointment.start | |||||
Definition | Date/Time that the appointment is to take place. | ||||
Short | When appointment is to take place | ||||
Control | 1..1 | ||||
Type | instant | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. Appointment.end | |||||
Definition | Date/Time that the appointment is to conclude. | ||||
Short | When appointment is to conclude | ||||
Control | 1..1 | ||||
Type | instant | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. 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. | ||||
Short | Can be less than start/end (e.g. estimate) | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. Appointment.slot | |||||
Definition | The slots from the participants' schedules that will be filled by the appointment. | ||||
Short | The slots that this appointment is filling | ||||
Control | 0..* | ||||
Type | Reference(Slot) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. 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. | ||||
Short | The date that this appointment was initially created | ||||
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. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. Appointment.comment | |||||
Definition | Additional comments about the appointment. | ||||
Short | Additional comments | ||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. 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). | ||||
Short | Detailed information and instructions for the patient | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. Appointment.basedOn | |||||
Definition | The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). | ||||
Short | The service request this appointment is allocated to assess | ||||
Comments | potentially relevant for CRD in some situations. | ||||
Control | 0..* | ||||
Type | Reference(CRD Service Request) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | incomingReferral | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. Appointment.participant | |||||
Definition | List of participants involved in the appointment. | ||||
Short | Participants involved in appointment | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists() )ele-1: All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) ) | ||||
62. 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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
64. 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. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
66. 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). | ||||
Short | Extensions that cannot be ignored even if unrecognized | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
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. | ||||
Alternate Names | extensions, user content, modifiers | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
68. Appointment.participant.type | |||||
Definition | Role of participant in the appointment. | ||||
Short | Role of participant in the appointment | ||||
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. | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from ParticipantType Role of participant in encounter. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. Appointment.participant.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Short | Patient, Practitioner or Location | ||||
Control | 0..1 | ||||
Type | Reference(CRD Patient, CRD Practitioner, CRD Location) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. 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. | ||||
Short | required | optional | information-only | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
74. Appointment.participant.status | |||||
Definition | Participation status of the actor. | ||||
Short | accepted | declined | tentative | needs-action | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
76. Appointment.participant.period | |||||
Definition | Participation period of the actor. | ||||
Short | Participation period of the actor | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
78. 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. | ||||
Short | Potential date/time interval(s) requested to allocate the appointment within | ||||
Comments | This does not introduce a capacity for recurring appointments. | ||||
Control | 1..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |