0.1.0 - ci-build

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

Resource Profile: HL7® AT Scheduling AppointmentResponse Profile

Official URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-appointmentresponse Version: 0.1.0
Draft as of 2024-12-16 Responsible: HL7® Austria, TC FHIR® Computable Name: HL7ATSchedulingAppointmentResponse

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.

This structure is derived from AppointmentResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AppointmentResponse.participantStatusrequiredAppointmentResponseStatus
http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AppointmentResponse.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
AppointmentResponse.participantTypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
AppointmentResponse.participantStatusrequiredAppointmentResponseStatus
http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AppointmentResponse

Summary

Differential View

This structure is derived from AppointmentResponse

NameFlagsCard.TypeDescription & Constraintsdoco
.. AppointmentResponse 0..* AppointmentResponse A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AppointmentResponse.participantStatusrequiredAppointmentResponseStatus
http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AppointmentResponse.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
AppointmentResponse.participantTypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
AppointmentResponse.participantStatusrequiredAppointmentResponseStatus
http://hl7.org/fhir/ValueSet/appointmentresponse-status|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apr-1errorAppointmentResponseEither the participantType or actor must be specified
: participantType.exists() or actor.exists()
dom-2errorAppointmentResponseIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentResponseIf 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-4errorAppointmentResponseIf 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-5errorAppointmentResponseIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentResponseA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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