Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.2) 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: New Dunedin Hospital Outpatient Appointment Response Profile

This profile derives from the AppointmentResponse Resource with localisations using international and NZ standards including the FHIR NZ Base IG, for use in the NZ context.

Usages:

• Examples for this Profile: AppointmentResponse/NDHOutpatientAppointmentResponseExample
• 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
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	Conformance	ValueSet	URI
AppointmentResponse.participantStatus	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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
appointment	S	1..1	Reference(Appointment)	Appointment this response relates to
start		0..0
end		0..0
participantType		0..0
participantStatus	S	1..1	code	accepted | declined | tentative | needs-action
comment		0..0
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
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
actor	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | 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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AppointmentResponse.participantStatus	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Must-Support: 2 elements
Prohibited: 4 elements

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
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	Conformance	ValueSet	URI
AppointmentResponse.participantStatus	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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
appointment	S	1..1	Reference(Appointment)	Appointment this response relates to
start		0..0
end		0..0
participantType		0..0
participantStatus	S	1..1	code	accepted | declined | tentative | needs-action
comment		0..0
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
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
actor	Σ	0..1	Reference(Patient | Practitioner | PractitionerRole | 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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AppointmentResponse.participantStatus	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Must-Support: 2 elements
Prohibited: 4 elements

Other representations of profile: CSV, Excel, Schematron