This is the set of resources that conform to both CH ORF Appointment (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment) and CH ORF Appointment (http://fhir.ch/ig/ch-orf/StructureDefinition/ch-orf-appointment).
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Appointment | C | 0..* | 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
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. ele-1: All FHIR elements must have a @value or children | ||||
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) ele-1: All FHIR elements must have a @value or children | ||||
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: ?? (example) ele-1: All FHIR elements must have a @value or children | ||||
serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ?? (example) ele-1: All FHIR elements must have a @value or children | ||||
serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ?? (example) ele-1: All FHIR elements must have a @value or children | ||||
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: ?? (preferred) ele-1: All FHIR elements must have a @value or children | ||||
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: ?? (preferred) ele-1: All FHIR elements must have a @value or children | ||||
reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: ?? (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children | ||||
reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the appointment is to take place (resource) ele-1: All FHIR elements must have a @value or children | |||||
priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize ele-1: All FHIR elements must have a @value or children | |||||
description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list ele-1: All FHIR elements must have a @value or children | |||||
supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment ele-1: All FHIR elements must have a @value or children | |||||
start | SΣ | 0..1 | instant | When appointment is to take place (required if status="pending" or "booked") ele-1: All FHIR elements must have a @value or children | ||||
end | SΣ | 0..1 | instant | When appointment is to conclude (required if status="pending" or "booked") ele-1: All FHIR elements must have a @value or children | ||||
minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) ele-1: All FHIR elements must have a @value or children | |||||
slot | 0..* | Reference(Slot) | The slots that this appointment is filling ele-1: All FHIR elements must have a @value or children | |||||
created | 0..1 | dateTime | The date that this appointment was initially created ele-1: All FHIR elements must have a @value or children | |||||
comment | 0..1 | string | Additional comments ele-1: All FHIR elements must have a @value or children | |||||
patientInstruction | S | 0..1 | string | Patient-oriented instructions SHALL be here and NOT in ServiceRequest.patientInstruction ele-1: All FHIR elements must have a @value or children | ||||
basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess ele-1: All FHIR elements must have a @value or children | |||||
participant | SC | 1..1 | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ?? (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children | ||||
actor | SΣ | 0..1 | Reference(CH ORF Location | #sd-ch-orf-location-ch-orf-location) | Name, address and telecom of the appointment location ele-1: All FHIR elements must have a @value or children | ||||
required | Σ | 0..1 | code | required | optional | information-only Binding: ?? (required): Is the Participant required to attend the appointment. ele-1: All FHIR elements must have a @value or children | ||||
status | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ?? (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children | ||||
period | 0..1 | Period | Participation period of the actor ele-1: All FHIR elements must have a @value or children | |||||
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. ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
start | SΣ | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children | ||||
end | SΣ | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |