LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Official URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/cdm-appointment | Version: 8.0.0 | |||
| Active as of 2022-11-10 | Computable Name: CDMAppointment | |||
LinuxForHealth Common Data Model definition of what fields we currently define for an appointment
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) | |
  meta | 0..1 | ProcessMeta | Metadata about a resource | |
 contained | 0..0 | |||
  Slices for identifier | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type | |
  identifier:All Slices | Content/Rules for all slices | |||
  type | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | |
| system | 1..1 | uri | The namespace for the identifier value | |
 value | 1..1 | string | The value that is unique | |
  identifier:Source | 0..1 | Identifier | External Ids for this item | |
  use | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
 type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
 code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SSRI | |
| cancelationReason | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason Value Set (example) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.identifier.type | extensible | IdentifierTypeValueSet |
| Appointment.cancelationReason | example | AppointmentCancellationReasonValueSet |
| 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) |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type |
| identifier:All Slices | Content/Rules for all slices | |||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:Source | Σ | 0..1 | Identifier | External Ids for this item |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SSRI | |
| status | ?!Σ | 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. |
| cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason Value Set (example) |
| participant | C | 1..* | BackboneElement | Participants involved in appointment |
| 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.identifier.use | required | IdentifierUse |
| Appointment.identifier.type | extensible | IdentifierTypeValueSet |
| Appointment.identifier:Source.use | required | Pattern: official |
| Appointment.identifier:Source.type | extensible | Pattern: SSRI |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancelationReason | example | AppointmentCancellationReasonValueSet |
| Appointment.participant.status | required | ParticipationStatus |
| 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 | ProcessMeta | Metadata about a 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type | ||||
| identifier: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 Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:Source | Σ | 0..1 | Identifier | External Ids for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
 type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
 id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SSRI | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 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. | ||||
| cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason Value Set (example) | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType | Σ | 0..* | CodeableConcept | 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) | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| reasonReference | 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 | |||||
| description | 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 | |||||
| start | Σ | 0..1 | instant | When appointment is to take place | ||||
| end | Σ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
| slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created | 0..1 | dateTime | The date that this appointment was initially created | |||||
| comment | 0..1 | string | Additional comments | |||||
| patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| participant | C | 1..* | BackboneElement | Participants involved in appointment | ||||
| 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 | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period | 0..1 | Period | Participation period of the actor | |||||
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| Appointment.identifier.use | required | IdentifierUse | ||||
| Appointment.identifier.type | extensible | IdentifierTypeValueSet | ||||
| Appointment.identifier:Source.use | required | Pattern: official | ||||
| Appointment.identifier:Source.type | extensible | Pattern: SSRI | ||||
| Appointment.status | required | AppointmentStatus | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonValueSet | ||||
| Appointment.serviceCategory | example | ServiceCategory | ||||
| Appointment.serviceType | example | ServiceType | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
This structure is derived from Appointment
Summary
Mandatory: 3 elements (1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
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) | |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
| contained | 0..0 | |||
| Slices for identifier | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type | |
| identifier:All Slices | Content/Rules for all slices | |||
| type | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | |
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| identifier:Source | 0..1 | Identifier | External Ids for this item | |
| use | 0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| type | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SSRI | |
| cancelationReason | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason Value Set (example) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Appointment.identifier.type | extensible | IdentifierTypeValueSet |
| Appointment.cancelationReason | example | AppointmentCancellationReasonValueSet |
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) |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | Σ | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type |
| identifier:All Slices | Content/Rules for all slices | |||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:Source | Σ | 0..1 | Identifier | External Ids for this item |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SSRI | |
| status | ?!Σ | 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. |
| cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason Value Set (example) |
| participant | C | 1..* | BackboneElement | Participants involved in appointment |
| 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. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Appointment.identifier.use | required | IdentifierUse |
| Appointment.identifier.type | extensible | IdentifierTypeValueSet |
| Appointment.identifier:Source.use | required | Pattern: official |
| Appointment.identifier:Source.type | extensible | Pattern: SSRI |
| Appointment.status | required | AppointmentStatus |
| Appointment.cancelationReason | example | AppointmentCancellationReasonValueSet |
| Appointment.participant.status | required | ParticipationStatus |
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 | ProcessMeta | Metadata about a 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | Σ | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type | ||||
| identifier: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 Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:Source | Σ | 0..1 | Identifier | External Ids for this item | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://linuxforhealth.org/fhir/cdm/CodeSystem/identifier-type | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SSRI | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 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. | ||||
| cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: Appointment Cancellation Reason Value Set (example) | ||||
| serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType | Σ | 0..* | CodeableConcept | 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) | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| reasonReference | 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 | |||||
| description | 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 | |||||
| start | Σ | 0..1 | instant | When appointment is to take place | ||||
| end | Σ | 0..1 | instant | When appointment is to conclude | ||||
| minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
| slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| created | 0..1 | dateTime | The date that this appointment was initially created | |||||
| comment | 0..1 | string | Additional comments | |||||
| patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
| basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
| participant | C | 1..* | BackboneElement | Participants involved in appointment | ||||
| 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 | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
| required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period | 0..1 | Period | Participation period of the actor | |||||
| requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Appointment.language | preferred | CommonLanguages
| ||||
| Appointment.identifier.use | required | IdentifierUse | ||||
| Appointment.identifier.type | extensible | IdentifierTypeValueSet | ||||
| Appointment.identifier:Source.use | required | Pattern: official | ||||
| Appointment.identifier:Source.type | extensible | Pattern: SSRI | ||||
| Appointment.status | required | AppointmentStatus | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonValueSet | ||||
| Appointment.serviceCategory | example | ServiceCategory | ||||
| Appointment.serviceType | example | ServiceType | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes | ||||
| Appointment.participant.type | extensible | ParticipantType | ||||
| Appointment.participant.required | required | ParticipantRequired | ||||
| Appointment.participant.status | required | ParticipationStatus |
This structure is derived from Appointment
Summary
Mandatory: 3 elements (1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron