NHDR Implementation Guide Release 1.0
0.1.0 - ci-build

NHDR Implementation Guide Release 1.0, published by NHDR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/UP-Manila-SILab/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions

Resource Profile: PH Appointment

Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Appointment Version: 0.1.0
Standards status: Draft Computable Name: PH_Appointment

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time.

Usages:

  • This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Constraints: app-2, app-3, app-4
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant 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())

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Appointment.meta
Appointment.meta.Slices for extension Content/Rules for all slices
Appointment.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Appointment.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Appointment.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Appointment.implicitRules 0..0 A set of rules under which this content was created
Appointment.language 0..0 Language of the resource content
Appointment.contained 0..0 Contained, inline Resources
Appointment.extension 0..0 Extension
Appointment.modifierExtension 0..0 Extension
Appointment.status 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
Appointment.cancelationReason 0..0 The coded reason for the appointment being cancelled
Appointment.serviceCategory 0..0 A broad categorization of the service that is to be performed during this appointment
Appointment.serviceType 0..0 The specific service that is to be performed during this appointment
Appointment.specialty 0..0 The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType 0..0 The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode 0..0 Coded reason this appointment is scheduled
Appointment.reasonReference 0..0 Reason the appointment is to take place (resource)
Appointment.priority 0..0 Used to make informed decisions if needing to re-prioritize
Appointment.description 0..0 Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation 0..0 Additional information to support the appointment
Appointment.start 0..0 When appointment is to take place
Appointment.end 0..0 When appointment is to conclude
Appointment.minutesDuration 0..0 Can be less than start/end (e.g. estimate)
Appointment.slot 0..0 The slots that this appointment is filling
Appointment.comment 0..0 Additional comments
Appointment.patientInstruction 0..0 Detailed information and instructions for the patient
Appointment.basedOn 0..0 The service request this appointment is allocated to assess
Appointment.participant
Appointment.participant.extension 0..0 Extension
Appointment.participant.modifierExtension 0..0 Extension
Appointment.participant.type 0..0 Role of participant in the appointment
Appointment.participant.required 0..0 required | optional | information-only
Appointment.participant.period 0..0 Participation period of the actor

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Constraints: app-2, app-3, app-4
Appointment.id This element is included in summaries. 0..1 id Logical id of this artifact
Appointment.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Appointment.meta.id 0..1 string Unique id for inter-element referencing
Appointment.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Appointment.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Appointment.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Appointment.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Appointment.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Appointment.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Appointment.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Appointment.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Appointment.identifier This element is included in summaries. 0..* Identifier External Ids for this item
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
Appointment.created 0..1 dateTime The date that this appointment was initially created
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.id 0..1 string Unique id for inter-element referencing
Appointment.participant.actor This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Appointment.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant 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 Appointment

Summary

Prohibited: 28 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Constraints: app-2, app-3, app-4
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant 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())

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Appointment.meta
Appointment.meta.Slices for extension Content/Rules for all slices
Appointment.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Appointment.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Appointment.meta.lastUpdated 0..1 instant When the resource was uploaded to the NHDR.
Appointment.implicitRules 0..0 A set of rules under which this content was created
Appointment.language 0..0 Language of the resource content
Appointment.text 0..0 Text summary of the resource, for human interpretation
Appointment.contained 0..0 Contained, inline Resources
Appointment.extension 0..0 Extension
Appointment.modifierExtension 0..0 Extension
Appointment.status 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
Appointment.cancelationReason 0..0 The coded reason for the appointment being cancelled
Appointment.serviceCategory 0..0 A broad categorization of the service that is to be performed during this appointment
Appointment.serviceType 0..0 The specific service that is to be performed during this appointment
Appointment.specialty 0..0 The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType 0..0 The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode 0..0 Coded reason this appointment is scheduled
Appointment.reasonReference 0..0 Reason the appointment is to take place (resource)
Appointment.priority 0..0 Used to make informed decisions if needing to re-prioritize
Appointment.description 0..0 Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation 0..0 Additional information to support the appointment
Appointment.start 0..0 When appointment is to take place
Appointment.end 0..0 When appointment is to conclude
Appointment.minutesDuration 0..0 Can be less than start/end (e.g. estimate)
Appointment.slot 0..0 The slots that this appointment is filling
Appointment.comment 0..0 Additional comments
Appointment.patientInstruction 0..0 Detailed information and instructions for the patient
Appointment.basedOn 0..0 The service request this appointment is allocated to assess
Appointment.participant
Appointment.participant.extension 0..0 Extension
Appointment.participant.modifierExtension 0..0 Extension
Appointment.participant.type 0..0 Role of participant in the appointment
Appointment.participant.required 0..0 required | optional | information-only
Appointment.participant.period 0..0 Participation period of the actor

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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)
Constraints: app-2, app-3, app-4
Appointment.id This element is included in summaries. 0..1 id Logical id of this artifact
Appointment.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Appointment.meta.id 0..1 string Unique id for inter-element referencing
Appointment.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Appointment.meta.Slices for extension.extension:hfRecordedDate 0..1 dateTime The recorded date indicating when the record was uploaded by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFRecordedDate
Appointment.meta.Slices for extension.extension:hfLastUpdated 0..* dateTime The date indicating when the record was last updated by the health facility.
URL: https://nhdr.gov.ph/fhir/StructureDefinition/HFLastUpdated
Appointment.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Appointment.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource was uploaded to the NHDR.
Appointment.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Appointment.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Appointment.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Appointment.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Appointment.identifier This element is included in summaries. 0..* Identifier External Ids for this item
Appointment.status This element is a modifier element. This element is included in summaries. 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: AppointmentStatus (required)
Appointment.created 0..1 dateTime The date that this appointment was initially created
Appointment.participant C 1..* BackboneElement Participants involved in appointment
Constraints: app-1
Appointment.participant.id 0..1 string Unique id for inter-element referencing
Appointment.participant.actor This element is included in summaries. 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
Appointment.participant.status This element is included in summaries. 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Appointment.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Appointment.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Appointment.status Base required AppointmentStatus 📍4.0.1 FHIR Std.
Appointment.participant.​status Base required ParticipationStatus 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
app-1 error Appointment.participant 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 Appointment

Summary

Prohibited: 28 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron