Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: DHO Appointment Response Profile

This profile derives from the AppointmentResponse Resource for use in the Dunedin Hospital Outpatients context.

Dunedin Hospital Outpatient AppointmentResponse profile

Usages:

• Examples for this Profile: AppointmentResponse/DHOAppointmentResponseExample
• CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

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
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
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
participantType	SΣ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
participantStatus	?!SΣ	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
AppointmentResponse.​participantType	Base	extensible	Participant type	📍4.0.1	FHIR Std.
AppointmentResponse.​participantStatus	Base	required	ParticipationStatus	📍4.0.1	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 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	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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AppointmentResponse		0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
appointment	S	1..1	Reference(Appointment)	Appointment this response relates to
start		0..0		Time from appointment, or requested new start time
end		0..0		Time from appointment, or requested new end time
participantType	S	1..1	CodeableConcept	Role of participant in the appointment
actor		0..0		Person, Location, HealthcareService, or Device
participantStatus	S	1..1	code	accepted | declined | tentative | needs-action
comment		0..0		Additional comments
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
participantType	SΣ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
participantStatus	?!SΣ	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
AppointmentResponse.​meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
AppointmentResponse.​meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
AppointmentResponse.​meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
AppointmentResponse.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AppointmentResponse.​participantType	Base	extensible	Participant type	📍4.0.1	FHIR Std.
AppointmentResponse.​participantStatus	Base	required	ParticipationStatus	📍4.0.1	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 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	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

Summary

Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 4 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AppointmentResponse.meta.tag

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
participantType	SΣ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
participantStatus	?!SΣ	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
AppointmentResponse.​participantType	Base	extensible	Participant type	📍4.0.1	FHIR Std.
AppointmentResponse.​participantStatus	Base	required	ParticipationStatus	📍4.0.1	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 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	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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AppointmentResponse		0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
meta
source		1..1	uri	HPI Facility ID from where the record is sourced
Slices for tag		1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
appointment	S	1..1	Reference(Appointment)	Appointment this response relates to
start		0..0		Time from appointment, or requested new start time
end		0..0		Time from appointment, or requested new end time
participantType	S	1..1	CodeableConcept	Role of participant in the appointment
actor		0..0		Person, Location, HealthcareService, or Device
participantStatus	S	1..1	code	accepted | declined | tentative | needs-action
comment		0..0		Additional comments
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	1..1	uri	HPI Facility ID from where the record is sourced
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	1..*	Coding	Correlation-id where the record is sourced Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External Ids for this item
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
participantType	SΣ	1..1	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
participantStatus	?!SΣ	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
AppointmentResponse.​meta.security	Base	extensible	SecurityLabels	📍4.0.1	FHIR Std.
AppointmentResponse.​meta.tag	Base	example	Common Tags	📍4.0.1	FHIR Std.
AppointmentResponse.​meta.tag:correlationId	Base	example	Common Tags	📍4.0.1	FHIR Std.
AppointmentResponse.​language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AppointmentResponse.​participantType	Base	extensible	Participant type	📍4.0.1	FHIR Std.
AppointmentResponse.​participantStatus	Base	required	ParticipationStatus	📍4.0.1	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 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	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

Summary

Mandatory: 1 element(5 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 4 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of AppointmentResponse.meta.tag

Other representations of profile: CSV, Excel, Schematron