This is the set of resources that conform to either of the profiles FR Core Appointment Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment) and FR Core Appointment Profile (https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-appointment). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Appointment | C | 0..* | 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) 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 |
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 | |
versionId | Σ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children |
lastUpdated | Σ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children |
source | Σ | 0..1 | uri | Identifies where the resource comes from ele-1: All FHIR elements must have a @value or children |
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children |
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children |
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". 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 | Extension 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 | Σ | 0..* | Identifier | External Ids for this item ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: ?? (required): The free/busy status of an appointment. 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: ?? (required) 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 | Σ | 0..1 | instant | When appointment is to take place ele-1: All FHIR elements must have a @value or children |
end | Σ | 0..1 | instant | When appointment is to conclude 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(FR Core Slot Profile | #sd-fr-core-slot-fr-core-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 | 0..1 | string | Detailed information and instructions for the patient 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 | C | 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 | Σ | 0..1 | Reference(Device | PractitionerRole | FR Core Related Person Profile | FR Core Healthcare Service Profile | FR Core Practitioner Profile | FR Core Patient Profile | FR Core Location Profile) | Person, Location/HealthcareService or Device 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 | Σ | 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 | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |