Generated Narrative: StructureDefinition profile-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 #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:proposedNewTime 0..1 boolean R5: Indicator for a counter proposal (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AppointmentResponse.proposedNewTime #xD; extension:recurring 0..1 boolean R5: This response is for all occurrences in a recurring request (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AppointmentResponse.recurring #xD; extension:occurrenceDate 0..1 date R5: Original date within a recurring request (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AppointmentResponse.occurrenceDate #xD; extension:recurrenceId 0..1 positiveInt R5: The recurrence ID of the specific recurring request (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AppointmentResponse.recurrenceId #xD; appointment #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:appointment 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: appointment additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; actor #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:actor 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Person(s), Location, HealthcareService, or Device URL: http://hl7.org/fhir/StructureDefinition/alternate-reference #xD; participantStatus #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:participantStatus 0..1 code R5: accepted | declined | tentative | needs-action | entered-in-error URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AppointmentResponse.participantStatus Binding: R5AppointmentresponseStatusForR3Participationstatus (0.1.0) (required): The Participation status of an appointment. #xD; Documentation for this format
Cross-version Profile for R5.AppointmentResponse for use in FHIR STU3
This cross-version profile allows R5 AppointmentResponse content to be represented via FHIR STU3 AppointmentResponse resources.
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL NOT contain any narrative
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
Either the participantType or actor must be specified
participantType.exists() or actor.exists()
(exists(f:participantType) or exists(f:actor))
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
R5: Indicator for a counter proposal (new)
R5: `AppointmentResponse.proposedNewTime` (new:boolean)
Element `AppointmentResponse.proposedNewTime` has a context of AppointmentResponse based on following the parent source element upwards and mapping to `AppointmentResponse`. Element `AppointmentResponse.proposedNewTime` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
R5: This response is for all occurrences in a recurring request (new)
R5: `AppointmentResponse.recurring` (new:boolean)
Element `AppointmentResponse.recurring` has a context of AppointmentResponse based on following the parent source element upwards and mapping to `AppointmentResponse`. Element `AppointmentResponse.recurring` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). When a recurring appointment is requested, the participant may choose to respond to each individual occurrence, in which case AppointmentResponse.recurring should be false. If the participant chooses to respond the same way for all occurrences, they may instead use a single AppointmentResponse with recurring set to true. These may be combined as the participant chooses. For example, they may accept all occurrences (recurring = true), but then send a decline for a specific occurrence (recurring=false).
R5: Original date within a recurring request (new)
R5: `AppointmentResponse.occurrenceDate` (new:date)
Element `AppointmentResponse.occurrenceDate` has a context of AppointmentResponse based on following the parent source element upwards and mapping to `AppointmentResponse`. Element `AppointmentResponse.occurrenceDate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).
R5: The recurrence ID of the specific recurring request (new)
R5: `AppointmentResponse.recurrenceId` (new:positiveInt)
Element `AppointmentResponse.recurrenceId` has a context of AppointmentResponse based on following the parent source element upwards and mapping to `AppointmentResponse`. Element `AppointmentResponse.recurrenceId` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). If the recurrence template was defined using the list of occurrenceDates then this property might not be used.
May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
Appointment that this response is replying to.
scheduleRequest.ActAppointmentRequest[@moodCode <= 'ARQ']
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
R5: `AppointmentResponse.appointment` additional types from child elements (display, identifier, reference, type)
Element `AppointmentResponse.appointment` is mapped to FHIR STU3 element `AppointmentResponse.appointment` as `SourceIsBroaderThanTarget`. The mappings for `AppointmentResponse.appointment` do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AppointmentResponse.appointment` with unmapped reference targets: Appointment.
Literal reference, Relative, internal or absolute URL
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Logical reference, when literal reference is not known
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Plain text narrative that identifies the resource in addition to the resource reference.
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Time from appointment, or requested new start time
Date/Time that the appointment is to take place, or requested new start time.
This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.
Time from appointment, or requested new end time
This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.
(performer | reusableDevice | subject | location).@typeCode
Person, Location/HealthcareService or Device
A Person, Location/HealthcareService or Device that is participating in the appointment.
performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)
R5: Person(s), Location, HealthcareService, or Device
Element `AppointmentResponse.actor` is mapped to FHIR STU3 element `AppointmentResponse.actor` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AppointmentResponse.actor` with unmapped reference targets: Device, Group, HealthcareService, Location, Patient, Practitioner, PractitionerRole, RelatedPerson.
accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.
The Participation status of an appointment.
(performer | reusableDevice | subject | location).statusCode
ATTENDEE;CN="Brian Postlethwaite";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)
unique id for the element within a resource (for internal references)
R5: accepted | declined | tentative | needs-action | entered-in-error
R5: `AppointmentResponse.participantStatus`
Element `AppointmentResponse.participantStatus` is mapped to FHIR STU3 element `AppointmentResponse.participantStatus` as `SourceIsBroaderThanTarget`. The target context `AppointmentResponse.participantStatus` is a modifier element, so this extension does not need to be defined as a modifier. This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.
Additional comments about the appointment.
This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.
.subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value