1.0.0 - release
            
          
CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.cambio.se/StructureDefinition/AppointmentBookingSe/v1 | Version: | |||
| Active as of 2025-10-27 | Computable Name: AppointmentBookingSe | |||
AppointmentBookingSe is a profile based on the FHIR resource Appointment.
AppointmentBookingSe is used for patients scheduling a new appointment. An appointment needs information about the patient, the healthcare service to be performed, as well as a slot for booking the appointment. AppointmentBookingSe is profiled for the Swedish market.
| COS version | Profile version | Required COSMIC version | Date | Description | 
|---|---|---|---|---|
| 3.0.0 | 1.0.0 | R8.3.05 | May 2022 | Initial version, support for POST. | 
| FHIR status | Status in COSMIC | 
|---|---|
| Proposed | Open, New | 
| HTTP Method | Description | 
|---|---|
| POST | Create appointment booking. | 
POST [baseURL]/Appointment (Post)
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | AppointmentCoreSe | 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) Constraints: app-2, app-3, app-4  | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]()  | 
0..1 | string | Phone number given by patient URL: https://fhir.cambio.se/StructureDefinition/appointment-patientGivenPhoneNumber  | |
![]() ![]() ![]()  | 
0..1 | string | Purpose for visit URL: https://fhir.cambio.se/StructureDefinition/appointment-purposeForVisit  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 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. Fixed Value: proposed  | 
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to take place | 
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to conclude | 
![]() ![]()  | 
1..1 | Reference(Slot) | The slots that this appointment is filling | |
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Slot  | 
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
![]() ![]()  | 
C | 3..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:$this Constraints: app-1  | 
![]() ![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Appointment.status | required | Fixed Value: proposedhttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard  | |
| Appointment.slot.type | extensible | Fixed Value: Slothttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:location.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:practitioner.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:device.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:healthcareService.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:practitionerRole.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| app-1 | error | Appointment.participant, Appointment.participant:patient, Appointment.participant:location, Appointment.participant:practitioner, Appointment.participant:device, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | 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 | 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 | 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().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 | 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()  | 
This structure is derived from AppointmentCoreSe
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | AppointmentCoreSe | 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) | |
![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]()  | 
0..1 | string | Phone number given by patient URL: https://fhir.cambio.se/StructureDefinition/appointment-patientGivenPhoneNumber  | |
![]() ![]() ![]()  | 
0..1 | string | Purpose for visit URL: https://fhir.cambio.se/StructureDefinition/appointment-purposeForVisit  | |
![]() ![]()  | 
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Fixed Value: proposed  | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | instant | When appointment is to take place | |
![]() ![]()  | 
1..1 | instant | When appointment is to conclude | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | Reference(Slot) | The slots that this appointment is filling | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
![]() ![]()  | 
3..* | BackboneElement | Participants involved in appointment | |
![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]()  | 
1..1 | BackboneElement | Participants involved in appointment | |
![]() ![]() ![]()  | 
1..1 | BackboneElement | Participants involved in appointment | |
![]() ![]() ![]()  | 
1..1 | BackboneElement | Participants involved in appointment | |
![]() ![]()  | 
0..0 | |||
  Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | AppointmentCoreSe | 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) Constraints: app-2, app-3, app-4  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
0..1 | string | Phone number given by patient URL: https://fhir.cambio.se/StructureDefinition/appointment-patientGivenPhoneNumber  | |||||
![]() ![]() ![]()  | 
0..1 | string | Purpose for visit URL: https://fhir.cambio.se/StructureDefinition/appointment-purposeForVisit  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | ||||
![]() ![]()  | 
?!Σ | 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. Fixed Value: proposed  | ||||
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to take place | ||||
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to conclude | ||||
![]() ![]()  | 
1..1 | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Slot  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The value that is unique Example General: 123456  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
![]() ![]()  | 
C | 3..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:$this Constraints: app-1  | ||||
![]() ![]() ![]()  | 
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Device) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(HealthcareService) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(PractitionerRole) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Appointment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Appointment.status | required | Fixed Value: proposedhttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.slot.type | extensible | Fixed Value: Slothttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:patient.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:patient.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:location.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:location.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:location.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitioner.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:practitioner.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitioner.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:device.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:device.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:device.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:healthcareService.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:healthcareService.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:healthcareService.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitionerRole.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:practitionerRole.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitionerRole.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| app-1 | error | Appointment.participant, Appointment.participant:patient, Appointment.participant:location, Appointment.participant:practitioner, Appointment.participant:device, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | 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 | 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 | 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().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 | 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()  | 
This structure is derived from AppointmentCoreSe
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | AppointmentCoreSe | 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) Constraints: app-2, app-3, app-4  | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]()  | 
0..1 | string | Phone number given by patient URL: https://fhir.cambio.se/StructureDefinition/appointment-patientGivenPhoneNumber  | |
![]() ![]() ![]()  | 
0..1 | string | Purpose for visit URL: https://fhir.cambio.se/StructureDefinition/appointment-purposeForVisit  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 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. Fixed Value: proposed  | 
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to take place | 
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to conclude | 
![]() ![]()  | 
1..1 | Reference(Slot) | The slots that this appointment is filling | |
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Slot  | 
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
![]() ![]()  | 
C | 3..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:$this Constraints: app-1  | 
![]() ![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Appointment.status | required | Fixed Value: proposedhttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard  | |
| Appointment.slot.type | extensible | Fixed Value: Slothttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:location.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:practitioner.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:device.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:healthcareService.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | |
| Appointment.participant:practitionerRole.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| app-1 | error | Appointment.participant, Appointment.participant:patient, Appointment.participant:location, Appointment.participant:practitioner, Appointment.participant:device, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | 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 | 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 | 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().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 | 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()  | 
Differential View
This structure is derived from AppointmentCoreSe
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | AppointmentCoreSe | 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) | |
![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]()  | 
0..0 | |||
![]() ![]() ![]()  | 
0..1 | string | Phone number given by patient URL: https://fhir.cambio.se/StructureDefinition/appointment-patientGivenPhoneNumber  | |
![]() ![]() ![]()  | 
0..1 | string | Purpose for visit URL: https://fhir.cambio.se/StructureDefinition/appointment-purposeForVisit  | |
![]() ![]()  | 
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Fixed Value: proposed  | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | instant | When appointment is to take place | |
![]() ![]()  | 
1..1 | instant | When appointment is to conclude | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
1..1 | Reference(Slot) | The slots that this appointment is filling | |
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..0 | |||
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |
![]() ![]()  | 
3..* | BackboneElement | Participants involved in appointment | |
![]() ![]()  | 
Content/Rules for all slices | |||
![]() ![]() ![]()  | 
1..1 | BackboneElement | Participants involved in appointment | |
![]() ![]() ![]()  | 
1..1 | BackboneElement | Participants involved in appointment | |
![]() ![]() ![]()  | 
1..1 | BackboneElement | Participants involved in appointment | |
![]() ![]()  | 
0..0 | |||
  Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | AppointmentCoreSe | 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) Constraints: app-2, app-3, app-4  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
0..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
0..1 | string | Phone number given by patient URL: https://fhir.cambio.se/StructureDefinition/appointment-patientGivenPhoneNumber  | |||||
![]() ![]() ![]()  | 
0..1 | string | Purpose for visit URL: https://fhir.cambio.se/StructureDefinition/appointment-purposeForVisit  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | ||||
![]() ![]()  | 
?!Σ | 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. Fixed Value: proposed  | ||||
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to take place | ||||
![]() ![]()  | 
Σ | 1..1 | instant | When appointment is to conclude | ||||
![]() ![]()  | 
1..1 | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Slot  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The value that is unique Example General: 123456  | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
![]() ![]()  | 
C | 3..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:$this Constraints: app-1  | ||||
![]() ![]() ![]()  | 
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Patient) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Location) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Practitioner) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(Device) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 1..1 | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(HealthcareService) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]()  | 
C | 0..* | BackboneElement | Participants involved in appointment Constraints: app-1  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Reference(PractitionerRole) | Person, Location/HealthcareService or Device | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.  | ||||
![]() ![]() ![]() ![]()  | 
0..1 | Period | Participation period of the actor | |||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Appointment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Appointment.status | required | Fixed Value: proposedhttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.slot.type | extensible | Fixed Value: Slothttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:patient.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:patient.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:patient.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:location.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:location.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:location.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitioner.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:practitioner.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitioner.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:device.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:device.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:device.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:healthcareService.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:healthcareService.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:healthcareService.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitionerRole.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Appointment.participant:practitionerRole.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard  | ||||
| Appointment.participant:practitionerRole.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| app-1 | error | Appointment.participant, Appointment.participant:patient, Appointment.participant:location, Appointment.participant:practitioner, Appointment.participant:device, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | 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 | 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 | 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().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 | 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()  | 
This structure is derived from AppointmentCoreSe
Other representations of profile: CSV, Excel, Schematron