Left: | CH ORF Appointment (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment) |
Right: | CH ORF Appointment (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment) |
Error | StructureDefinition.version | Values for version differ: '3.0.0-ballot' vs '3.0.0-ci-build' |
Information | StructureDefinition.date | Values for date differ: '2024-05-17T06:31:46+00:00' vs '2024-10-15T15:54:56+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Appointment | ||
copyright | CC0-1.0 | ||
date | 2024-05-17T06:31:46+00:00 | 2024-10-15T15:54:56+00:00 |
|
description | Profile to describe the location and time for the fulfillment of the service request. In this resource, the status of the appointment is defined, patient-oriented instructions are listed here and where and when the service request is to be fulfilled. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#CH | ||
kind | resource | ||
name | ChOrfAppointment | ||
publisher | HL7 Switzerland | ||
purpose | |||
status | active | ||
title | CH ORF Appointment | ||
type | Appointment | ||
url | http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment | ||
version | 3.0.0-ballot | 3.0.0-ci-build |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | Appointment | CH ORF Appointment app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show | C | 0..* | Appointment | CH ORF Appointment app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show | |||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | SΣ | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may
change in time whereas Appointment.status reflects the status at the time the appointment is initiated. | SΣ | 0..* | Identifier | External identifier for this item: May be used for referencing to a record in a scheduling application. Status in the scheduling application may
change in time whereas Appointment.status reflects the status at the time the appointment is initiated. | |||||||||
status | ?!SΣ | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: ?? (required) | ?!SΣ | 1..1 | code | Used to express if time and date are the preference of the patient (="proposed"), confirmed by the patient but not yet by the service provider
(="pending") or confirmed by the patient and the service provider (="booked") Binding: ?? (required) | |||||||||
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: ?? (example) | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: ?? (example) | |||||||||
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ?? (example) | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ?? (example) | |||||||||
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ?? (example) | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ?? (example) | |||||||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: ?? (preferred) | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: ?? (preferred) | |||||||||
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: ?? (preferred) | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: ?? (preferred) | |||||||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: ?? (preferred): The Reason for the appointment to take place. | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: ?? (preferred): The Reason for the appointment to take place. | |||||||||
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) | |||||||||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||||||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||||||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | 0..* | Reference(Resource) | Additional information to support the appointment | |||||||||||
start | SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") | SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") | |||||||||
end | SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") | SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") | |||||||||
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||||||||
slot | 0..* | Reference(Slot) | The slots that this appointment is filling | 0..* | Reference(Slot) | The slots that this appointment is filling | |||||||||||
created | 0..1 | dateTime | The date that this appointment was initially created | 0..1 | dateTime | The date that this appointment was initially created | |||||||||||
comment | 0..1 | string | Additional comments | 0..1 | string | Additional comments | |||||||||||
patientInstruction | S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction | S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction | |||||||||
basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||||||||
participant | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ?? (extensible): Role of participant in encounter. | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ?? (extensible): Role of participant in encounter. | |||||||||
actor | SΣ | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location | SΣ | 0..1 | Reference(CH ORF Location) | Name, address and telecom of the appointment location | |||||||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ?? (required): Is the Participant required to attend the appointment. | Σ | 0..1 | code | required | optional | information-only Binding: ?? (required): Is the Participant required to attend the appointment. | |||||||||
status | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ?? (required): The Participation status of an appointment. Required Pattern: tentative | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ?? (required): The Participation status of an appointment. Required Pattern: tentative | |||||||||
period | 0..1 | Period | Participation period of the actor | 0..1 | Period | Participation period of the actor | |||||||||||
requestedPeriod | S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have
the same value for start and end. | S | 0..1 | Period | Single Date/time or Date/time-interval indication for the appointment with the status="proposed". A single Date/time indication MUST have
the same value for start and end. | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | |||||||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |||||||||
Documentation for this format |