TCFHIRAGSchedulingR5 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: HL7® AT Scheduling AppointmentResponse Profile

HL7® Austria FHIR® Scheduling Profile for appointmentresponse data in Austria.

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.

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

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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
appointment	Σ	1..1	Reference(Appointment)	Appointment this response relates to ele-1: All FHIR elements must have a @value or children
participantStatus	?!Σ	1..1	code	accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.participantStatus	required	AppointmentResponseStatus http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
AppointmentResponse		0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
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
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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	Σ	0..*	Identifier	External Ids for this item
appointment	Σ	1..1	Reference(Appointment)	Appointment this response relates to
proposedNewTime	Σ	0..1	boolean	Indicator for a counter proposal
start		0..1	instant	Time from appointment, or requested new start time
end		0..1	instant	Time from appointment, or requested new end time
participantType	ΣC	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	ΣC	0..1	Reference(Patient | Group | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person(s), Location, HealthcareService, or Device
participantStatus	?!Σ	1..1	code	accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment.
comment		0..1	markdown	Additional comments
recurring		0..1	boolean	This response is for all occurrences in a recurring request
occurrenceDate		0..1	date	Original date within a recurring request
recurrenceId		0..1	positiveInt	The recurrence ID of the specific recurring request
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
AppointmentResponse.participantType	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
AppointmentResponse.participantStatus	required	AppointmentResponseStatus http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
appointment	Σ	1..1	Reference(Appointment)	Appointment this response relates to ele-1: All FHIR elements must have a @value or children
participantStatus	?!Σ	1..1	code	accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.participantStatus	required	AppointmentResponseStatus http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
AppointmentResponse		0..*	AppointmentResponse	A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
Documentation for this format

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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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	Σ	0..*	Identifier	External Ids for this item
appointment	Σ	1..1	Reference(Appointment)	Appointment this response relates to
proposedNewTime	Σ	0..1	boolean	Indicator for a counter proposal
start		0..1	instant	Time from appointment, or requested new start time
end		0..1	instant	Time from appointment, or requested new end time
participantType	ΣC	0..*	CodeableConcept	Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor	ΣC	0..1	Reference(Patient | Group | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)	Person(s), Location, HealthcareService, or Device
participantStatus	?!Σ	1..1	code	accepted | declined | tentative | needs-action | entered-in-error Binding: AppointmentResponseStatus (required): The Participation status of an appointment.
comment		0..1	markdown	Additional comments
recurring		0..1	boolean	This response is for all occurrences in a recurring request
occurrenceDate		0..1	date	Original date within a recurring request
recurrenceId		0..1	positiveInt	The recurrence ID of the specific recurring request
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AppointmentResponse.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
AppointmentResponse.participantType	extensible	ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard
AppointmentResponse.participantStatus	required	AppointmentResponseStatus http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Other representations of profile: CSV, Excel, Schematron