3.0.0-alpha - ci-build
3.0.0-alpha - ci-build
Publication Build: This will be filled in by the publication tooling
| Official URL: http://hl7.no/fhir/StructureDefinition/no-basis-Appointment | Version: 3.0.0-alpha | |||
| Draft as of 2023-06-13 | Computable Name: NoBasisAppointment | |||
Base profile for Norwegian Appointment information. Defined by HL7 Norway. This profile identifies a set of minimum expectations for an Appointment resource when creating, searching and retrieving compositions by defining which coding system(s) must be present when using this profile. The basis profile is open, but derived profiles should close down the information elements according to specification relevant to the use-case.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
  cancellationReason | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled | |
 appointmentType | ||||
   Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this | |
   coding:omsorgsNiva | 0..1 | Coding | Volven 8406 Binding: urn:oid:2.16.578.1.12.4.1.1.8406 (extensible): Volven | |
| coding:kontaktType | 0..1 | Coding | Volven 8432 Binding: urn:oid:2.16.578.1.12.4.1.1.8432 (extensible): Volven | |
 coding:innbygger | 0..1 | Coding | Volven 7617 Binding: urn:oid:2.16.578.1.12.4.1.1.7617 (extensible): Volven | |
| Slices for participant | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:resolve().actor | |
 participant:practitioner | 0..* | BackboneElement | Appointments should contain information regarding the pracitioner involved. The Appointment.actor should contain a Practitioner or PractitionerRole reference | |
   actor | 0..1 | Reference(Practitioner | PractitionerRole) | The individual, device, location, or service participating in the appointment | |
| participant:patient | 0..* | BackboneElement | Appointments should contain information regarding the patient involved. The Appointment.actor should contain a Patient reference | |
| actor | 0..1 | Reference(Patient) | The individual, device, location, or service participating in the appointment | |
 participant:location | 0..1 | BackboneElement | Appointments should contain information regarding where the appointment is executed. The Appointment.actor should contain a Location or HealthcareService reference | |
| actor | 0..1 | Reference(Location | HealthcareService) | The individual, device, location, or service participating in the appointment | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.appointmentType.coding:omsorgsNiva | extensible | |
| Appointment.appointmentType.coding:kontaktType | extensible | |
| Appointment.appointmentType.coding:innbygger | extensible | |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
 cancellationReason | ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
| start | ΣC | 0..1 | instant | When appointment is to take place |
| end | ΣC | 0..1 | instant | When appointment is to conclude |
| Slices for participant | C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:resolve().actor |
| participant:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:practitioner | C | 0..* | BackboneElement | Appointments should contain information regarding the pracitioner involved. The Appointment.actor should contain a Practitioner or PractitionerRole reference |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The individual, device, location, or service participating in the appointment |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:patient | C | 0..* | BackboneElement | Appointments should contain information regarding the patient involved. The Appointment.actor should contain a Patient reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 0..1 | Reference(Patient) | The individual, device, location, or service participating in the appointment |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:location | C | 0..1 | BackboneElement | Appointments should contain information regarding where the appointment is executed. The Appointment.actor should contain a Location or HealthcareService reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 0..1 | Reference(Location | HealthcareService) | The individual, device, location, or service participating in the appointment |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancellationReason | example | AppointmentCancellationReason |
| Appointment.participant.status | required | ParticipationStatus |
| Appointment.participant:practitioner.status | required | ParticipationStatus |
| Appointment.participant:patient.status | required | ParticipationStatus |
| Appointment.participant:location.status | required | ParticipationStatus |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant, Appointment.participant:practitioner, Appointment.participant:patient, Appointment.participant:location | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
| app-4 | error | Appointment | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
| app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or status='cancelled') | |
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Appointment | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| status | ?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
| cancellationReason | ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
| class | Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. |
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
| serviceType | Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) |
| appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this |
| coding:omsorgsNiva | Σ | 0..1 | Coding | Volven 8406 Binding: urn:oid:2.16.578.1.12.4.1.1.8406 (extensible): Volven |
| coding:kontaktType | Σ | 0..1 | Coding | Volven 8432 Binding: urn:oid:2.16.578.1.12.4.1.1.8432 (extensible): Volven |
| coding:innbygger | Σ | 0..1 | Coding | Volven 7617 Binding: urn:oid:2.16.578.1.12.4.1.1.7617 (extensible): Volven |
 text | Σ | 0..1 | string | Plain text representation of the concept |
| reason | Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
| priority | 0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |
| description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |
| replaces | 0..* | Reference(Appointment) | Appointment replaced by this Appointment | |
| virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |
| previousAppointment | 0..1 | Reference(Appointment) | The previous appointment in a series | |
| originatingAppointment | C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments |
| start | ΣC | 0..1 | instant | When appointment is to take place |
| end | ΣC | 0..1 | instant | When appointment is to conclude |
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |
| created | 0..1 | dateTime | The date that this appointment was initially created | |
| cancellationDate | C | 0..1 | dateTime | When the appointment was cancelled |
| note | 0..* | Annotation | Additional comments | |
| patientInstruction | 0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |
| basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |
| subject | Σ | 0..1 | Reference(Patient | Group) | The patient or group associated with the appointment |
| Slices for participant | C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:resolve().actor |
| participant:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:practitioner | C | 0..* | BackboneElement | Appointments should contain information regarding the pracitioner involved. The Appointment.actor should contain a Practitioner or PractitionerRole reference |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:patient | C | 0..* | BackboneElement | Appointments should contain information regarding the patient involved. The Appointment.actor should contain a Patient reference |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Patient) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:location | C | 0..1 | BackboneElement | Appointments should contain information regarding where the appointment is executed. The Appointment.actor should contain a Location or HealthcareService reference |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Location | HealthcareService) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| recurrenceId | 0..1 | positiveInt | The sequence number in the recurrence | |
| occurrenceChanged | 0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |
| recurrenceTemplate | C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| timezone | 0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |
| recurrenceType | 1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |
| lastOccurrenceDate | 0..1 | date | The date when the recurrence should end | |
| occurrenceCount | 0..1 | positiveInt | The number of planned occurrences | |
| occurrenceDate | 0..* | date | Specific dates for a recurring set of appointments (no template) | |
| weeklyTemplate | 0..1 | BackboneElement | Information about weekly recurring appointments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| monday | 0..1 | boolean | Recurs on Mondays | |
| tuesday | 0..1 | boolean | Recurs on Tuesday | |
| wednesday | 0..1 | boolean | Recurs on Wednesday | |
| thursday | 0..1 | boolean | Recurs on Thursday | |
| friday | 0..1 | boolean | Recurs on Friday | |
| saturday | 0..1 | boolean | Recurs on Saturday | |
| sunday | 0..1 | boolean | Recurs on Sunday | |
| weekInterval | 0..1 | positiveInt | Recurs every nth week | |
| monthlyTemplate | 0..1 | BackboneElement | Information about monthly recurring appointments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| dayOfMonth | 0..1 | positiveInt | Recurs on a specific day of the month | |
| nthWeekOfMonth | 0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |
| dayOfWeek | 0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |
| monthInterval | 1..1 | positiveInt | Recurs every nth month | |
| yearlyTemplate | 0..1 | BackboneElement | Information about yearly recurring appointments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| yearInterval | 1..1 | positiveInt | Recurs every nth year | |
| excludingDate | 0..* | date | Any dates that should be excluded from the series | |
| excludingRecurrenceId | 0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.language | required | AllLanguages |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancellationReason | example | AppointmentCancellationReason |
| Appointment.class | preferred | http://terminology.hl7.org/ValueSet/EncounterClass |
| Appointment.serviceCategory | example | ServiceCategory |
| Appointment.serviceType | example | ServiceType |
| Appointment.specialty | preferred | PracticeSettingCodeValueSet |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes |
| Appointment.appointmentType.coding:omsorgsNiva | extensible | |
| Appointment.appointmentType.coding:kontaktType | extensible | |
| Appointment.appointmentType.coding:innbygger | extensible | |
| Appointment.reason | preferred | EncounterReasonCodes |
| Appointment.priority | example | ActPriority |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.status | required | ParticipationStatus |
| Appointment.participant:practitioner.type | extensible | ParticipantType |
| Appointment.participant:practitioner.status | required | ParticipationStatus |
| Appointment.participant:patient.type | extensible | ParticipantType |
| Appointment.participant:patient.status | required | ParticipationStatus |
| Appointment.participant:location.type | extensible | ParticipantType |
| Appointment.participant:location.status | required | ParticipationStatus |
| Appointment.recurrenceTemplate.timezone | required | IANATimezones (a valid code from https://www.iana.org/time-zones) |
| Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceType |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonth |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeek |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant, Appointment.participant:practitioner, Appointment.participant:patient, Appointment.participant:location | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Appointment
Summary
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
| cancellationReason | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled | |
| appointmentType | ||||
| Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this | |
| coding:omsorgsNiva | 0..1 | Coding | Volven 8406 Binding: urn:oid:2.16.578.1.12.4.1.1.8406 (extensible): Volven | |
| coding:kontaktType | 0..1 | Coding | Volven 8432 Binding: urn:oid:2.16.578.1.12.4.1.1.8432 (extensible): Volven | |
| coding:innbygger | 0..1 | Coding | Volven 7617 Binding: urn:oid:2.16.578.1.12.4.1.1.7617 (extensible): Volven | |
| Slices for participant | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:resolve().actor | |
| participant:practitioner | 0..* | BackboneElement | Appointments should contain information regarding the pracitioner involved. The Appointment.actor should contain a Practitioner or PractitionerRole reference | |
| actor | 0..1 | Reference(Practitioner | PractitionerRole) | The individual, device, location, or service participating in the appointment | |
| participant:patient | 0..* | BackboneElement | Appointments should contain information regarding the patient involved. The Appointment.actor should contain a Patient reference | |
| actor | 0..1 | Reference(Patient) | The individual, device, location, or service participating in the appointment | |
| participant:location | 0..1 | BackboneElement | Appointments should contain information regarding where the appointment is executed. The Appointment.actor should contain a Location or HealthcareService reference | |
| actor | 0..1 | Reference(Location | HealthcareService) | The individual, device, location, or service participating in the appointment | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.appointmentType.coding:omsorgsNiva | extensible | |
| Appointment.appointmentType.coding:kontaktType | extensible | |
| Appointment.appointmentType.coding:innbygger | extensible | |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
| cancellationReason | ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
| start | ΣC | 0..1 | instant | When appointment is to take place |
| end | ΣC | 0..1 | instant | When appointment is to conclude |
| Slices for participant | C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:resolve().actor |
| participant:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:practitioner | C | 0..* | BackboneElement | Appointments should contain information regarding the pracitioner involved. The Appointment.actor should contain a Practitioner or PractitionerRole reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The individual, device, location, or service participating in the appointment |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:patient | C | 0..* | BackboneElement | Appointments should contain information regarding the patient involved. The Appointment.actor should contain a Patient reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 0..1 | Reference(Patient) | The individual, device, location, or service participating in the appointment |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:location | C | 0..1 | BackboneElement | Appointments should contain information regarding where the appointment is executed. The Appointment.actor should contain a Location or HealthcareService reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | ΣC | 0..1 | Reference(Location | HealthcareService) | The individual, device, location, or service participating in the appointment |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancellationReason | example | AppointmentCancellationReason |
| Appointment.participant.status | required | ParticipationStatus |
| Appointment.participant:practitioner.status | required | ParticipationStatus |
| Appointment.participant:patient.status | required | ParticipationStatus |
| Appointment.participant:location.status | required | ParticipationStatus |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant, Appointment.participant:practitioner, Appointment.participant:patient, Appointment.participant:location | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
| app-4 | error | Appointment | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
| app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
| app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
| app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or status='cancelled') | |
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Appointment | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | External Ids for this item |
| status | ?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
| cancellationReason | ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
| class | Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. |
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
| serviceType | Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) |
| specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) |
| appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:$this |
| coding:omsorgsNiva | Σ | 0..1 | Coding | Volven 8406 Binding: urn:oid:2.16.578.1.12.4.1.1.8406 (extensible): Volven |
| coding:kontaktType | Σ | 0..1 | Coding | Volven 8432 Binding: urn:oid:2.16.578.1.12.4.1.1.8432 (extensible): Volven |
| coding:innbygger | Σ | 0..1 | Coding | Volven 7617 Binding: urn:oid:2.16.578.1.12.4.1.1.7617 (extensible): Volven |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| reason | Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. |
| priority | 0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |
| description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |
| replaces | 0..* | Reference(Appointment) | Appointment replaced by this Appointment | |
| virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |
| supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |
| previousAppointment | 0..1 | Reference(Appointment) | The previous appointment in a series | |
| originatingAppointment | C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments |
| start | ΣC | 0..1 | instant | When appointment is to take place |
| end | ΣC | 0..1 | instant | When appointment is to conclude |
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |
| created | 0..1 | dateTime | The date that this appointment was initially created | |
| cancellationDate | C | 0..1 | dateTime | When the appointment was cancelled |
| note | 0..* | Annotation | Additional comments | |
| patientInstruction | 0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |
| basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |
| subject | Σ | 0..1 | Reference(Patient | Group) | The patient or group associated with the appointment |
| Slices for participant | C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:resolve().actor |
| participant:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:practitioner | C | 0..* | BackboneElement | Appointments should contain information regarding the pracitioner involved. The Appointment.actor should contain a Practitioner or PractitionerRole reference |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:patient | C | 0..* | BackboneElement | Appointments should contain information regarding the patient involved. The Appointment.actor should contain a Patient reference |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Patient) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| participant:location | C | 0..1 | BackboneElement | Appointments should contain information regarding where the appointment is executed. The Appointment.actor should contain a Location or HealthcareService reference |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
| period | 0..1 | Period | Participation period of the actor | |
| actor | ΣC | 0..1 | Reference(Location | HealthcareService) | The individual, device, location, or service participating in the appointment |
| required | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
| recurrenceId | 0..1 | positiveInt | The sequence number in the recurrence | |
| occurrenceChanged | 0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |
| recurrenceTemplate | C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| timezone | 0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |
| recurrenceType | 1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |
| lastOccurrenceDate | 0..1 | date | The date when the recurrence should end | |
| occurrenceCount | 0..1 | positiveInt | The number of planned occurrences | |
| occurrenceDate | 0..* | date | Specific dates for a recurring set of appointments (no template) | |
| weeklyTemplate | 0..1 | BackboneElement | Information about weekly recurring appointments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| monday | 0..1 | boolean | Recurs on Mondays | |
| tuesday | 0..1 | boolean | Recurs on Tuesday | |
| wednesday | 0..1 | boolean | Recurs on Wednesday | |
| thursday | 0..1 | boolean | Recurs on Thursday | |
| friday | 0..1 | boolean | Recurs on Friday | |
| saturday | 0..1 | boolean | Recurs on Saturday | |
| sunday | 0..1 | boolean | Recurs on Sunday | |
| weekInterval | 0..1 | positiveInt | Recurs every nth week | |
| monthlyTemplate | 0..1 | BackboneElement | Information about monthly recurring appointments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| dayOfMonth | 0..1 | positiveInt | Recurs on a specific day of the month | |
| nthWeekOfMonth | 0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |
| dayOfWeek | 0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |
| monthInterval | 1..1 | positiveInt | Recurs every nth month | |
| yearlyTemplate | 0..1 | BackboneElement | Information about yearly recurring appointments | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| yearInterval | 1..1 | positiveInt | Recurs every nth year | |
| excludingDate | 0..* | date | Any dates that should be excluded from the series | |
| excludingRecurrenceId | 0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.language | required | AllLanguages |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancellationReason | example | AppointmentCancellationReason |
| Appointment.class | preferred | http://terminology.hl7.org/ValueSet/EncounterClass |
| Appointment.serviceCategory | example | ServiceCategory |
| Appointment.serviceType | example | ServiceType |
| Appointment.specialty | preferred | PracticeSettingCodeValueSet |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes |
| Appointment.appointmentType.coding:omsorgsNiva | extensible | |
| Appointment.appointmentType.coding:kontaktType | extensible | |
| Appointment.appointmentType.coding:innbygger | extensible | |
| Appointment.reason | preferred | EncounterReasonCodes |
| Appointment.priority | example | ActPriority |
| Appointment.participant.type | extensible | ParticipantType |
| Appointment.participant.status | required | ParticipationStatus |
| Appointment.participant:practitioner.type | extensible | ParticipantType |
| Appointment.participant:practitioner.status | required | ParticipationStatus |
| Appointment.participant:patient.type | extensible | ParticipantType |
| Appointment.participant:patient.status | required | ParticipationStatus |
| Appointment.participant:location.type | extensible | ParticipantType |
| Appointment.participant:location.status | required | ParticipationStatus |
| Appointment.recurrenceTemplate.timezone | required | IANATimezones (a valid code from https://www.iana.org/time-zones) |
| Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceType |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonth |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeek |
| Id | Grade | Path(s) | Details | Requirements |
| app-1 | error | Appointment.participant, Appointment.participant:practitioner, Appointment.participant:patient, Appointment.participant:location | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Appointment
Summary
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron