SIL HIE Implementation Guide
0.1.0 - sil-hie-active

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

Resource Profile: HIE AppointmentResponse

Official URL: https://nshr.dha.go.ke/fhir/StructureDefinition/hie-appointmentresponse Version: 0.1.0
Active as of 2025-11-25 Computable Name: HIEAppointmentResponse

R4B AppointmentResponse constrained for HIE scheduling responses, requiring clear linkage to the appointment, a well-typed actor, and a participant status.

Usages:

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: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Constraints: apr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this item
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... assigner SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... start 1..1 instant Time from appointment, or requested new start time
... end 1..1 instant Time from appointment, or requested new end time
... participantType Σ 0..* HIECodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 HIEReference(HIE Patient | HIE Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location, HealthcareService, or Device
... participantStatus ?!SΣ 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
AppointmentResponse.​identifier.use Base required IdentifierUse 📦4.3.0 FHIR Std.
AppointmentResponse.​identifier.type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AppointmentResponse.​participantType Base extensible ParticipantType 📍4.3.0 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse 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 AppointmentResponse

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... identifier S 1..* Identifier External Ids for this item
.... use 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... assigner S 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... appointment S 1..1 HIEReference(HIE Appointment) Appointment this response relates to
... start 1..1 instant Time from appointment, or requested new start time
... participantType 0..* HIECodeableConcept Role of participant in the appointment
... actor S 1..1 HIEReference(HIE Patient | HIE Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location, HealthcareService, or Device
... participantStatus S 1..1 code accepted | declined | tentative | needs-action

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AppointmentResponse.​identifier.use Base required IdentifierUse 📦4.3.0 FHIR Std.
AppointmentResponse.​identifier.type Base extensible IdentifierType 📦4.3.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Constraints: apr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 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 SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... appointment SΣ 1..1 HIEReference(HIE Appointment) Appointment this response relates to
... start 1..1 instant Time from appointment, or requested new start time
... end 1..1 instant Time from appointment, or requested new end time
... participantType Σ 0..* HIECodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 HIEReference(HIE Patient | HIE Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location, HealthcareService, or Device
... participantStatus ?!SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... comment 0..1 string Additional comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AppointmentResponse.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
AppointmentResponse.​identifier.use Base required IdentifierUse 📦4.3.0 FHIR Std.
AppointmentResponse.​identifier.type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AppointmentResponse.​participantType Base extensible ParticipantType 📍4.3.0 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning AppointmentResponse.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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Constraints: apr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this item
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... assigner SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... start 1..1 instant Time from appointment, or requested new start time
... end 1..1 instant Time from appointment, or requested new end time
... participantType Σ 0..* HIECodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 HIEReference(HIE Patient | HIE Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location, HealthcareService, or Device
... participantStatus ?!SΣ 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
AppointmentResponse.​identifier.use Base required IdentifierUse 📦4.3.0 FHIR Std.
AppointmentResponse.​identifier.type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AppointmentResponse.​participantType Base extensible ParticipantType 📍4.3.0 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse 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 AppointmentResponse

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
... identifier S 1..* Identifier External Ids for this item
.... use 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... assigner S 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... appointment S 1..1 HIEReference(HIE Appointment) Appointment this response relates to
... start 1..1 instant Time from appointment, or requested new start time
... participantType 0..* HIECodeableConcept Role of participant in the appointment
... actor S 1..1 HIEReference(HIE Patient | HIE Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location, HealthcareService, or Device
... participantStatus S 1..1 code accepted | declined | tentative | needs-action

doco Documentation for this format

Terminology Bindings (Differential)

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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AppointmentResponse C 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Constraints: apr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier External Ids for this item
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 1..1 HIECodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 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 SΣ 0..1 HIEReference(HIE Organization) Organization that issued id (may be just text)
... appointment SΣ 1..1 HIEReference(HIE Appointment) Appointment this response relates to
... start 1..1 instant Time from appointment, or requested new start time
... end 1..1 instant Time from appointment, or requested new end time
... participantType Σ 0..* HIECodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
... actor SΣ 1..1 HIEReference(HIE Patient | HIE Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location, HealthcareService, or Device
... participantStatus ?!SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... comment 0..1 string Additional comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AppointmentResponse.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
AppointmentResponse.​identifier.use Base required IdentifierUse 📦4.3.0 FHIR Std.
AppointmentResponse.​identifier.type Base extensible IdentifierType 📦4.3.0 FHIR Std.
AppointmentResponse.​participantType Base extensible ParticipantType 📍4.3.0 FHIR Std.
AppointmentResponse.​participantStatus Base required ParticipationStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
apr-1 error AppointmentResponse Either the participantType or actor must be specified participantType.exists() or actor.exists()
dom-2 error AppointmentResponse If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AppointmentResponse 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 AppointmentResponse 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 AppointmentResponse If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AppointmentResponse A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning AppointmentResponse.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()

 

Other representations of profile: CSV, Excel, Schematron