SIL HIE Implementation Guide, published by Kathurima Kimathi. 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/savannahghi/hie-fhir-ig-profile/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: HIE Appointment

R4B Appointment constrained for HIE scheduling, requiring clear status, timing, participants, and reason context.

Usages:

• Refer to this Profile: HIE AppointmentResponse
• Examples for this Profile: Appointment/HIEAppointment-example

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External Ids for this item
Appointment.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
Appointment.identifier.type	Σ This element is included in summaries. C	1..1	HIECodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Appointment.identifier.assigner	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Organization)	Organization that issued id (may be just text)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ 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): The free/busy status of an appointment.
Appointment.serviceCategory	Σ This element is included in summaries. C	1..*	HIECodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Constraints: cc-text-or-code
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example) Constraints: cc-text-or-code
Appointment.specialty	Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) Constraints: cc-text-or-code
Appointment.appointmentType	Σ This element is included in summaries. C	0..1	HIECodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) Constraints: cc-text-or-code
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries. C	1..*	HIECodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. Constraints: cc-text-or-code
Appointment.reasonReference		1..*	HIEReference(HIE Condition | Procedure | Observation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Scheduling priority; consider v3 ActPriority if coded elsewhere
Appointment.description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to take place
Appointment.end	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to conclude
Appointment.minutesDuration	S This element must be supported.	1..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot		0..*	HIEReference(Slot)	The slots that this appointment is filling
Appointment.created		1..1	dateTime	The date that this appointment was initially created
Appointment.basedOn		0..*	HIEReference(ServiceRequest)	The service request this appointment is allocated to assess
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.type	Σ This element is included in summaries. C	0..*	HIECodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Device | Location | HealthcareService)	Person, Location/HealthcareService or Device
Appointment.participant.status	S This element must be supported. Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.identifier.​use	Base	required	IdentifierUse	📦4.3.0	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📦4.3.0	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.3.0	FHIR Std.
Appointment.serviceCategory	Base	example	ServiceCategory	📍4.3.0	FHIR Std.
Appointment.serviceType	Base	example	ServiceType	📍4.3.0	FHIR Std.
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.3.0	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦3.0.0	THO v7.4
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.3.0	FHIR Std.
Appointment.participant.​type	Base	extensible	ParticipantType	📍4.3.0	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.3.0	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')
cc-text-or-code	warning	Appointment.identifier.type, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.participant.type	Text is optional, coding is required	coding.exists()
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.exists() and ('#'+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(uri) = '#').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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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.identifier	S This element must be supported.	1..*	Identifier	External Ids for this item
Appointment.identifier.use		1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
Appointment.identifier.type		1..1	HIECodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
Appointment.identifier.system		1..1	uri	The namespace for the identifier value
Appointment.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Appointment.identifier.assigner	S This element must be supported.	0..1	HIEReference(HIE Organization)	Organization that issued id (may be just text)
Appointment.status	S This element must be supported.	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Appointment.serviceCategory		1..*	HIECodeableConcept	A broad categorization of the service that is to be performed during this appointment
Appointment.serviceType	S This element must be supported.	0..*	HIECodeableConcept	The specific service that is to be performed during this appointment
Appointment.specialty		0..*	HIECodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType		0..1	HIECodeableConcept	The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode	S This element must be supported.	1..*	HIECodeableConcept	Coded reason this appointment is scheduled
Appointment.reasonReference		1..*	HIEReference(HIE Condition | Procedure | Observation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Scheduling priority; consider v3 ActPriority if coded elsewhere
Appointment.description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.start	S This element must be supported.	1..1	instant	When appointment is to take place
Appointment.end	S This element must be supported.	1..1	instant	When appointment is to conclude
Appointment.minutesDuration	S This element must be supported.	1..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot		0..*	HIEReference(Slot)	The slots that this appointment is filling
Appointment.created		1..1	dateTime	The date that this appointment was initially created
Appointment.basedOn		0..*	HIEReference(ServiceRequest)	The service request this appointment is allocated to assess
Appointment.participant	S This element must be supported.	1..*	BackboneElement	Participants involved in appointment
Appointment.participant.type		0..*	HIECodeableConcept	Role of participant in the appointment
Appointment.participant.actor	S This element must be supported.	0..1	HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Device | Location | HealthcareService)	Person, Location/HealthcareService or Device
Appointment.participant.status	S This element must be supported.	1..1	code	accepted | declined | tentative | needs-action
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.identifier.​use	Base	required	IdentifierUse	📦4.3.0	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📦4.3.0	FHIR Std.

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
Appointment.text		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
Appointment.contained		0..*	Resource	Contained, inline Resources Constraints: dom-r4b
Appointment.extension		0..*	Extension	Additional content defined by implementations
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External Ids for this item
Appointment.identifier.id		0..1	id	Unique id for inter-element referencing
Appointment.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
Appointment.identifier.type	Σ This element is included in summaries. C	1..1	HIECodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Appointment.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Appointment.identifier.assigner	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Organization)	Organization that issued id (may be just text)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ 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): The free/busy status of an appointment.
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
Appointment.serviceCategory	Σ This element is included in summaries. C	1..*	HIECodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Constraints: cc-text-or-code
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example) Constraints: cc-text-or-code
Appointment.specialty	Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) Constraints: cc-text-or-code
Appointment.appointmentType	Σ This element is included in summaries. C	0..1	HIECodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) Constraints: cc-text-or-code
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries. C	1..*	HIECodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. Constraints: cc-text-or-code
Appointment.reasonReference		1..*	HIEReference(HIE Condition | Procedure | Observation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Scheduling priority; consider v3 ActPriority if coded elsewhere
Appointment.description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to take place
Appointment.end	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to conclude
Appointment.minutesDuration	S This element must be supported.	1..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot		0..*	HIEReference(Slot)	The slots that this appointment is filling
Appointment.created		1..1	dateTime	The date that this appointment was initially created
Appointment.comment		0..1	string	Additional comments
Appointment.patientInstruction		0..1	string	Detailed information and instructions for the patient
Appointment.basedOn		0..*	HIEReference(ServiceRequest)	The service request this appointment is allocated to assess
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
Appointment.participant.id		0..1	string	Unique id for inter-element referencing
Appointment.participant.extension		0..*	Extension	Additional content defined by implementations
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.type	Σ This element is included in summaries. C	0..*	HIECodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Device | Location | HealthcareService)	Person, Location/HealthcareService or Device
Appointment.participant.required	Σ This element is included in summaries.	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.participant.status	S This element must be supported. Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.participant.period		0..1	Period	Participation period of the actor
Appointment.requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.language	Base	preferred	Common Languages	📍4.3.0	FHIR Std.
Appointment.identifier.​use	Base	required	IdentifierUse	📦4.3.0	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📦4.3.0	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.3.0	FHIR Std.
Appointment.cancelationReason	Base	example	AppointmentCancellationReason	📍4.3.0	FHIR Std.
Appointment.serviceCategory	Base	example	ServiceCategory	📍4.3.0	FHIR Std.
Appointment.serviceType	Base	example	ServiceType	📍4.3.0	FHIR Std.
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.3.0	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦3.0.0	THO v7.4
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.3.0	FHIR Std.
Appointment.participant.​type	Base	extensible	ParticipantType	📍4.3.0	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍4.3.0	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.3.0	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')
cc-text-or-code	warning	Appointment.identifier.type, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.participant.type	Text is optional, coding is required	coding.exists()
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	Appointment.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems	($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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

Mandatory: 13 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

• HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
• HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
• HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
• HIE Condition (https://nshr.dha.go.ke/fhir/StructureDefinition/condition)
• HIE Patient (https://nshr.dha.go.ke/fhir/StructureDefinition/patient)
• HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External Ids for this item
Appointment.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
Appointment.identifier.type	Σ This element is included in summaries. C	1..1	HIECodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Appointment.identifier.assigner	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Organization)	Organization that issued id (may be just text)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ 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): The free/busy status of an appointment.
Appointment.serviceCategory	Σ This element is included in summaries. C	1..*	HIECodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Constraints: cc-text-or-code
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example) Constraints: cc-text-or-code
Appointment.specialty	Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) Constraints: cc-text-or-code
Appointment.appointmentType	Σ This element is included in summaries. C	0..1	HIECodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) Constraints: cc-text-or-code
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries. C	1..*	HIECodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. Constraints: cc-text-or-code
Appointment.reasonReference		1..*	HIEReference(HIE Condition | Procedure | Observation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Scheduling priority; consider v3 ActPriority if coded elsewhere
Appointment.description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to take place
Appointment.end	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to conclude
Appointment.minutesDuration	S This element must be supported.	1..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot		0..*	HIEReference(Slot)	The slots that this appointment is filling
Appointment.created		1..1	dateTime	The date that this appointment was initially created
Appointment.basedOn		0..*	HIEReference(ServiceRequest)	The service request this appointment is allocated to assess
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.type	Σ This element is included in summaries. C	0..*	HIECodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Device | Location | HealthcareService)	Person, Location/HealthcareService or Device
Appointment.participant.status	S This element must be supported. Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.identifier.​use	Base	required	IdentifierUse	📦4.3.0	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📦4.3.0	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.3.0	FHIR Std.
Appointment.serviceCategory	Base	example	ServiceCategory	📍4.3.0	FHIR Std.
Appointment.serviceType	Base	example	ServiceType	📍4.3.0	FHIR Std.
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.3.0	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦3.0.0	THO v7.4
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.3.0	FHIR Std.
Appointment.participant.​type	Base	extensible	ParticipantType	📍4.3.0	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.3.0	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')
cc-text-or-code	warning	Appointment.identifier.type, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.participant.type	Text is optional, coding is required	coding.exists()
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.exists() and ('#'+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(uri) = '#').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 Appointment

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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.identifier	S This element must be supported.	1..*	Identifier	External Ids for this item
Appointment.identifier.use		1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
Appointment.identifier.type		1..1	HIECodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
Appointment.identifier.system		1..1	uri	The namespace for the identifier value
Appointment.identifier.value	S This element must be supported.	1..1	string	The value that is unique
Appointment.identifier.assigner	S This element must be supported.	0..1	HIEReference(HIE Organization)	Organization that issued id (may be just text)
Appointment.status	S This element must be supported.	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Appointment.serviceCategory		1..*	HIECodeableConcept	A broad categorization of the service that is to be performed during this appointment
Appointment.serviceType	S This element must be supported.	0..*	HIECodeableConcept	The specific service that is to be performed during this appointment
Appointment.specialty		0..*	HIECodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment
Appointment.appointmentType		0..1	HIECodeableConcept	The style of appointment or patient that has been booked in the slot (not service type)
Appointment.reasonCode	S This element must be supported.	1..*	HIECodeableConcept	Coded reason this appointment is scheduled
Appointment.reasonReference		1..*	HIEReference(HIE Condition | Procedure | Observation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Scheduling priority; consider v3 ActPriority if coded elsewhere
Appointment.description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.start	S This element must be supported.	1..1	instant	When appointment is to take place
Appointment.end	S This element must be supported.	1..1	instant	When appointment is to conclude
Appointment.minutesDuration	S This element must be supported.	1..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot		0..*	HIEReference(Slot)	The slots that this appointment is filling
Appointment.created		1..1	dateTime	The date that this appointment was initially created
Appointment.basedOn		0..*	HIEReference(ServiceRequest)	The service request this appointment is allocated to assess
Appointment.participant	S This element must be supported.	1..*	BackboneElement	Participants involved in appointment
Appointment.participant.type		0..*	HIECodeableConcept	Role of participant in the appointment
Appointment.participant.actor	S This element must be supported.	0..1	HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Device | Location | HealthcareService)	Person, Location/HealthcareService or Device
Appointment.participant.status	S This element must be supported.	1..1	code	accepted | declined | tentative | needs-action
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Appointment.identifier.​use	Base	required	IdentifierUse	📦4.3.0	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📦4.3.0	FHIR Std.

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Appointment.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): IETF language tag Additional Bindings Purpose AllLanguages Max Binding
Appointment.text		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
Appointment.contained		0..*	Resource	Contained, inline Resources Constraints: dom-r4b
Appointment.extension		0..*	Extension	Additional content defined by implementations
Appointment.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Appointment.identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	External Ids for this item
Appointment.identifier.id		0..1	id	Unique id for inter-element referencing
Appointment.identifier.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Appointment.identifier.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required)
Appointment.identifier.type	Σ This element is included in summaries. C	1..1	HIECodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible) Constraints: cc-text-or-code
Appointment.identifier.system	Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Appointment.identifier.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique Example General: 123456
Appointment.identifier.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Appointment.identifier.assigner	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Organization)	Organization that issued id (may be just text)
Appointment.status	?! This element is a modifier element. S This element must be supported. Σ 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): The free/busy status of an appointment.
Appointment.cancelationReason	Σ This element is included in summaries.	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
Appointment.serviceCategory	Σ This element is included in summaries. C	1..*	HIECodeableConcept	A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) Constraints: cc-text-or-code
Appointment.serviceType	S This element must be supported. Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specific service that is to be performed during this appointment Binding: ServiceType (example) Constraints: cc-text-or-code
Appointment.specialty	Σ This element is included in summaries. C	0..*	HIECodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) Constraints: cc-text-or-code
Appointment.appointmentType	Σ This element is included in summaries. C	0..1	HIECodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) Constraints: cc-text-or-code
Appointment.reasonCode	S This element must be supported. Σ This element is included in summaries. C	1..*	HIECodeableConcept	Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. Constraints: cc-text-or-code
Appointment.reasonReference		1..*	HIEReference(HIE Condition | Procedure | Observation)	Reason the appointment is to take place (resource)
Appointment.priority		0..1	unsignedInt	Scheduling priority; consider v3 ActPriority if coded elsewhere
Appointment.description		1..1	string	Shown on a subject line in a meeting request, or appointment list
Appointment.supportingInformation		0..*	Reference(Resource)	Additional information to support the appointment
Appointment.start	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to take place
Appointment.end	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When appointment is to conclude
Appointment.minutesDuration	S This element must be supported.	1..1	positiveInt	Can be less than start/end (e.g. estimate)
Appointment.slot		0..*	HIEReference(Slot)	The slots that this appointment is filling
Appointment.created		1..1	dateTime	The date that this appointment was initially created
Appointment.comment		0..1	string	Additional comments
Appointment.patientInstruction		0..1	string	Detailed information and instructions for the patient
Appointment.basedOn		0..*	HIEReference(ServiceRequest)	The service request this appointment is allocated to assess
Appointment.participant	S This element must be supported. C	1..*	BackboneElement	Participants involved in appointment Constraints: app-1
Appointment.participant.id		0..1	string	Unique id for inter-element referencing
Appointment.participant.extension		0..*	Extension	Additional content defined by implementations
Appointment.participant.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Appointment.participant.type	Σ This element is included in summaries. C	0..*	HIECodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. Constraints: cc-text-or-code
Appointment.participant.actor	S This element must be supported. Σ This element is included in summaries.	0..1	HIEReference(HIE Patient | HIE Practitioner | PractitionerRole | RelatedPerson | Device | Location | HealthcareService)	Person, Location/HealthcareService or Device
Appointment.participant.required	Σ This element is included in summaries.	0..1	code	required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
Appointment.participant.status	S This element must be supported. Σ This element is included in summaries.	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Appointment.participant.period		0..1	Period	Participation period of the actor
Appointment.requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Appointment.language	Base	preferred	Common Languages	📍4.3.0	FHIR Std.
Appointment.identifier.​use	Base	required	IdentifierUse	📦4.3.0	FHIR Std.
Appointment.identifier.​type	Base	extensible	IdentifierType	📦4.3.0	FHIR Std.
Appointment.status	Base	required	AppointmentStatus	📍4.3.0	FHIR Std.
Appointment.cancelationReason	Base	example	AppointmentCancellationReason	📍4.3.0	FHIR Std.
Appointment.serviceCategory	Base	example	ServiceCategory	📍4.3.0	FHIR Std.
Appointment.serviceType	Base	example	ServiceType	📍4.3.0	FHIR Std.
Appointment.specialty	Base	preferred	Practice Setting Code Value Set	📍4.3.0	FHIR Std.
Appointment.appointmentType	Base	preferred	hl7VS-appointmentReasonCodes	📦3.0.0	THO v7.4
Appointment.reasonCode	Base	preferred	Encounter Reason Codes	📍4.3.0	FHIR Std.
Appointment.participant.​type	Base	extensible	ParticipantType	📍4.3.0	FHIR Std.
Appointment.participant.​required	Base	required	ParticipantRequired	📍4.3.0	FHIR Std.
Appointment.participant.​status	Base	required	ParticipationStatus	📍4.3.0	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')
cc-text-or-code	warning	Appointment.identifier.type, Appointment.serviceCategory, Appointment.serviceType, Appointment.specialty, Appointment.appointmentType, Appointment.reasonCode, Appointment.participant.type	Text is optional, coding is required	coding.exists()
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b	warning	Appointment.contained	Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems	($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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

Mandatory: 13 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

• HIE CodeableConcept (https://nshr.dha.go.ke/fhir/StructureDefinition/codeable-concept)
• HIE Reference (https://nshr.dha.go.ke/fhir/StructureDefinition/reference)
• HIE Organization (https://nshr.dha.go.ke/fhir/StructureDefinition/organization)
• HIE Condition (https://nshr.dha.go.ke/fhir/StructureDefinition/condition)
• HIE Patient (https://nshr.dha.go.ke/fhir/StructureDefinition/patient)
• HIE Practitioner (https://nshr.dha.go.ke/fhir/StructureDefinition/practitioner)

Other representations of profile: CSV, Excel, Schematron