mamaTotofhirIG, published by IntelliSOFT Consulting Ke. 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/IntelliSOFT-Consulting/MamaToTo-FHIR-IG/ and changes regularly. See the Directory of published versions

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

Resource Profile: AppointmentResponseProfile

AppointmentResponseProfile

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

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

This structure is derived from AppointmentResponse

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse		0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
identifier	S	0..1	Identifier	External Ids for this item
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
appointment	S	1..1	Reference(Appointment)	Appointment this response relates to
start	S	0..1	instant	Time from appointment, or requested new start time
end	S	0..1	instant	Time from appointment, or requested new end time
participantType	S	0..*	CodeableConcept	Role of participant in the appointment
actor	S	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
comment	S	0..1	string	Additional comments
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	C	0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection apr-1: Either the participantType or actor must be specified
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..1	Identifier	External Ids for this item
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	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
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
start	S	0..1	instant	Time from appointment, or requested new start time
end	S	0..1	instant	Time from appointment, or requested new end time
participantType	SΣ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	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.
comment	S	0..1	string	Additional comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AppointmentResponse.participantType	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
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()

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	C	0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection apr-1: Either the participantType or actor must be specified
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..1	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	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	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
start	S	0..1	instant	Time from appointment, or requested new start time
end	S	0..1	instant	Time from appointment, or requested new end time
participantType	SΣ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	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.
comment	S	0..1	string	Additional comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AppointmentResponse.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AppointmentResponse.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AppointmentResponse.participantType	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
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

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 10 elements

Differential View

This structure is derived from AppointmentResponse

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse		0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
identifier	S	0..1	Identifier	External Ids for this item
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
appointment	S	1..1	Reference(Appointment)	Appointment this response relates to
start	S	0..1	instant	Time from appointment, or requested new start time
end	S	0..1	instant	Time from appointment, or requested new end time
participantType	S	0..*	CodeableConcept	Role of participant in the appointment
actor	S	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
comment	S	0..1	string	Additional comments
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	C	0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection apr-1: Either the participantType or actor must be specified
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..1	Identifier	External Ids for this item
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	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
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
start	S	0..1	instant	Time from appointment, or requested new start time
end	S	0..1	instant	Time from appointment, or requested new end time
participantType	SΣ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	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.
comment	S	0..1	string	Additional comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AppointmentResponse.participantType	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AppointmentResponse	C	0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection apr-1: Either the participantType or actor must be specified
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..1	Identifier	External Ids for this item
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	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	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
appointment	SΣ	1..1	Reference(Appointment)	Appointment this response relates to
start	S	0..1	instant	Time from appointment, or requested new start time
end	S	0..1	instant	Time from appointment, or requested new end time
participantType	SΣ	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	SΣ	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.
comment	S	0..1	string	Additional comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AppointmentResponse.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
AppointmentResponse.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
AppointmentResponse.participantType	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
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

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 10 elements

Other representations of profile: CSV, Excel, Schematron