{"abstract":false,"baseDefinition":"http://hl7.org/fhir/StructureDefinition/DomainResource","contact":[{"telecom":[{"system":"url","value":"http://hl7.org/fhir"}]},{"telecom":[{"system":"url","value":"http://www.hl7.org/Special/committees/pafm/index.cfm"}]}],"date":"2019-10-24T11:53:00+11:00","derivation":"specialization","description":"Base StructureDefinition for AppointmentResponse Resource","differential":{"element":[{"constraint":[{"expression":"participantType.exists() or actor.exists()","human":"Either the participantType or actor must be specified","key":"apr-1","severity":"error","xpath":"(exists(f:participantType) or exists(f:actor))"}],"definition":"A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.","id":"AppointmentResponse","mapping":[{"identity":"rim","map":"Appointment[@moodCode <= 'PRMS']"},{"identity":"ical","map":"VEVENT"},{"identity":"w5","map":"workflow.scheduling"}],"max":"*","min":0,"path":"AppointmentResponse","short":"A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection"},{"definition":"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.","id":"AppointmentResponse.identifier","isSummary":true,"mapping":[{"identity":"rim","map":".id"},{"identity":"ical","map":"UID"},{"identity":"w5","map":"id"}],"max":"*","min":0,"path":"AppointmentResponse.identifier","short":"External Ids for this item","type":[{"code":"Identifier"}]},{"definition":"Appointment that this response is replying to.","id":"AppointmentResponse.appointment","isSummary":true,"mapping":[{"identity":"rim","map":"scheduleRequest.ActAppointmentRequest[@moodCode <= 'ARQ']"}],"max":"1","min":1,"path":"AppointmentResponse.appointment","short":"Appointment this response relates to","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Appointment"}]},{"comment":"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.","definition":"Date/Time that the appointment is to take place, or requested new start time.","id":"AppointmentResponse.start","mapping":[{"identity":"rim","map":".effectiveTime.low"},{"identity":"w5","map":"when.init"}],"max":"1","min":0,"path":"AppointmentResponse.start","short":"Time from appointment, or requested new start time","type":[{"code":"instant"}]},{"definition":"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.","id":"AppointmentResponse.end","mapping":[{"identity":"rim","map":".effectiveTime.high"},{"identity":"w5","map":"when.done"}],"max":"1","min":0,"path":"AppointmentResponse.end","short":"Time from appointment, or requested new end time","type":[{"code":"instant"}]},{"binding":{"description":"Role of participant in encounter.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ParticipantType"}],"strength":"extensible","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/encounter-participant-type"}},"comment":"The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.","definition":"Role of participant in the appointment.","id":"AppointmentResponse.participantType","isSummary":true,"mapping":[{"identity":"rim","map":"(performer | reusableDevice | subject | location).@typeCode"},{"identity":"ical","map":"n/a"}],"max":"*","min":0,"path":"AppointmentResponse.participantType","short":"Role of participant in the appointment","type":[{"code":"CodeableConcept"}]},{"definition":"A Person, Location/HealthcareService or Device that is participating in the appointment.","id":"AppointmentResponse.actor","isSummary":true,"mapping":[{"identity":"v2","map":"PID-3-Patient ID List"},{"identity":"rim","map":"performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"},{"identity":"ical","map":"ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"},{"identity":"w5","map":"who"}],"max":"1","min":0,"path":"AppointmentResponse.actor","short":"Person, Location/HealthcareService or Device","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Patient"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/RelatedPerson"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Device"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/HealthcareService"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Location"}]},{"binding":{"description":"The Participation status of an appointment.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ParticipantStatus"}],"strength":"required","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/participationstatus"}},"comment":"This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.","definition":"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.","id":"AppointmentResponse.participantStatus","isModifier":true,"isSummary":true,"mapping":[{"identity":"rim","map":"(performer | reusableDevice | subject | location).statusCode"},{"identity":"ical","map":"ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"}],"max":"1","min":1,"path":"AppointmentResponse.participantStatus","short":"accepted | declined | tentative | in-process | completed | needs-action | entered-in-error","type":[{"code":"code"}]},{"comment":"This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.","definition":"Additional comments about the appointment.","id":"AppointmentResponse.comment","mapping":[{"identity":"rim","map":".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"},{"identity":"ical","map":"COMMENT"}],"max":"1","min":0,"path":"AppointmentResponse.comment","short":"Additional comments","type":[{"code":"string"}]}]},"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":3},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"pa"}],"fhirVersion":"3.0.2","id":"AppointmentResponse","kind":"resource","mapping":[{"identity":"rim","name":"RIM Mapping","uri":"http://hl7.org/v3"},{"identity":"ical","name":"iCalendar","uri":"http://www.ietf.org/rfc/rfc2445.txt"},{"identity":"w5","name":"W5 Mapping","uri":"http://hl7.org/fhir/w5"},{"identity":"v2","name":"HL7 v2 Mapping","uri":"http://hl7.org/v2"}],"meta":{"lastUpdated":"2019-10-24T11:53:00+11:00"},"name":"AppointmentResponse","publisher":"Health Level Seven International (Patient Administration)","resourceType":"StructureDefinition","snapshot":{"element":[{"constraint":[{"expression":"contained.contained.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain nested Resources","key":"dom-2","severity":"error","source":"DomainResource","xpath":"not(parent::f:contained and f:contained)"},{"expression":"contained.text.empty()","human":"If the resource is contained in another resource, it SHALL NOT contain any narrative","key":"dom-1","severity":"error","source":"DomainResource","xpath":"not(parent::f:contained and f:text)"},{"expression":"contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()","human":"If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated","key":"dom-4","severity":"error","source":"DomainResource","xpath":"not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"},{"expression":"contained.where(('#'+id in %resource.descendants().reference).not()).empty()","human":"If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource","key":"dom-3","severity":"error","source":"DomainResource","xpath":"not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"},{"expression":"participantType.exists() or actor.exists()","human":"Either the participantType or actor must be specified","key":"apr-1","severity":"error","xpath":"(exists(f:participantType) or exists(f:actor))"}],"definition":"A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.","id":"AppointmentResponse","mapping":[{"identity":"rim","map":"Entity. Role, or Act"},{"identity":"rim","map":"Appointment[@moodCode <= 'PRMS']"},{"identity":"ical","map":"VEVENT"},{"identity":"w5","map":"workflow.scheduling"}],"max":"*","min":0,"path":"AppointmentResponse","short":"A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection"},{"base":{"max":"1","min":0,"path":"Resource.id"},"comment":"The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","definition":"The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","id":"AppointmentResponse.id","isSummary":true,"max":"1","min":0,"path":"AppointmentResponse.id","short":"Logical id of this artifact","type":[{"code":"id"}]},{"base":{"max":"1","min":0,"path":"Resource.meta"},"definition":"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.","id":"AppointmentResponse.meta","isSummary":true,"max":"1","min":0,"path":"AppointmentResponse.meta","short":"Metadata about the resource","type":[{"code":"Meta"}]},{"base":{"max":"1","min":0,"path":"Resource.implicitRules"},"comment":"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.","definition":"A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.","id":"AppointmentResponse.implicitRules","isModifier":true,"isSummary":true,"max":"1","min":0,"path":"AppointmentResponse.implicitRules","short":"A set of rules under which this content was created","type":[{"code":"uri"}]},{"base":{"max":"1","min":0,"path":"Resource.language"},"binding":{"description":"A human language.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet","valueReference":{"reference":"http://hl7.org/fhir/ValueSet/all-languages"}},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"Language"},{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding","valueBoolean":true}],"strength":"extensible","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/languages"}},"comment":"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).","definition":"The base language in which the resource is written.","id":"AppointmentResponse.language","max":"1","min":0,"path":"AppointmentResponse.language","short":"Language of the resource content","type":[{"code":"code"}]},{"alias":["narrative","html","xhtml","display"],"base":{"max":"1","min":0,"path":"DomainResource.text"},"comment":"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.","condition":["dom-1"],"definition":"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.","id":"AppointmentResponse.text","mapping":[{"identity":"rim","map":"Act.text?"}],"max":"1","min":0,"path":"AppointmentResponse.text","short":"Text summary of the resource, for human interpretation","type":[{"code":"Narrative"}]},{"alias":["inline resources","anonymous resources","contained resources"],"base":{"max":"*","min":0,"path":"DomainResource.contained"},"comment":"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.","definition":"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.","id":"AppointmentResponse.contained","mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"AppointmentResponse.contained","short":"Contained, inline Resources","type":[{"code":"Resource"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.extension"},"comment":"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.","definition":"May be used to represent additional information that is not part of the basic definition of the resource. 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.","id":"AppointmentResponse.extension","mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"AppointmentResponse.extension","short":"Additional Content defined by implementations","type":[{"code":"Extension"}]},{"alias":["extensions","user content"],"base":{"max":"*","min":0,"path":"DomainResource.modifierExtension"},"comment":"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.","definition":"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.","id":"AppointmentResponse.modifierExtension","isModifier":true,"mapping":[{"identity":"rim","map":"N/A"}],"max":"*","min":0,"path":"AppointmentResponse.modifierExtension","short":"Extensions that cannot be ignored","type":[{"code":"Extension"}]},{"definition":"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.","id":"AppointmentResponse.identifier","isSummary":true,"mapping":[{"identity":"rim","map":".id"},{"identity":"ical","map":"UID"},{"identity":"w5","map":"id"}],"max":"*","min":0,"path":"AppointmentResponse.identifier","short":"External Ids for this item","type":[{"code":"Identifier"}]},{"definition":"Appointment that this response is replying to.","id":"AppointmentResponse.appointment","isSummary":true,"mapping":[{"identity":"rim","map":"scheduleRequest.ActAppointmentRequest[@moodCode <= 'ARQ']"}],"max":"1","min":1,"path":"AppointmentResponse.appointment","short":"Appointment this response relates to","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Appointment"}]},{"comment":"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.","definition":"Date/Time that the appointment is to take place, or requested new start time.","id":"AppointmentResponse.start","mapping":[{"identity":"rim","map":".effectiveTime.low"},{"identity":"w5","map":"when.init"}],"max":"1","min":0,"path":"AppointmentResponse.start","short":"Time from appointment, or requested new start time","type":[{"code":"instant"}]},{"definition":"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.","id":"AppointmentResponse.end","mapping":[{"identity":"rim","map":".effectiveTime.high"},{"identity":"w5","map":"when.done"}],"max":"1","min":0,"path":"AppointmentResponse.end","short":"Time from appointment, or requested new end time","type":[{"code":"instant"}]},{"binding":{"description":"Role of participant in encounter.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ParticipantType"}],"strength":"extensible","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/encounter-participant-type"}},"comment":"The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment.\r\rIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\r\rThis value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.","definition":"Role of participant in the appointment.","id":"AppointmentResponse.participantType","isSummary":true,"mapping":[{"identity":"rim","map":"(performer | reusableDevice | subject | location).@typeCode"},{"identity":"ical","map":"n/a"}],"max":"*","min":0,"path":"AppointmentResponse.participantType","short":"Role of participant in the appointment","type":[{"code":"CodeableConcept"}]},{"definition":"A Person, Location/HealthcareService or Device that is participating in the appointment.","id":"AppointmentResponse.actor","isSummary":true,"mapping":[{"identity":"v2","map":"PID-3-Patient ID List"},{"identity":"rim","map":"performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation"},{"identity":"ical","map":"ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"},{"identity":"w5","map":"who"}],"max":"1","min":0,"path":"AppointmentResponse.actor","short":"Person, Location/HealthcareService or Device","type":[{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Patient"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Practitioner"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/RelatedPerson"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Device"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/HealthcareService"},{"code":"Reference","targetProfile":"http://hl7.org/fhir/StructureDefinition/Location"}]},{"binding":{"description":"The Participation status of an appointment.","extension":[{"url":"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName","valueString":"ParticipantStatus"}],"strength":"required","valueSetReference":{"reference":"http://hl7.org/fhir/ValueSet/participationstatus"}},"comment":"This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid.","definition":"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.","id":"AppointmentResponse.participantStatus","isModifier":true,"isSummary":true,"mapping":[{"identity":"rim","map":"(performer | reusableDevice | subject | location).statusCode"},{"identity":"ical","map":"ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"}],"max":"1","min":1,"path":"AppointmentResponse.participantStatus","short":"accepted | declined | tentative | in-process | completed | needs-action | entered-in-error","type":[{"code":"code"}]},{"comment":"This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.","definition":"Additional comments about the appointment.","id":"AppointmentResponse.comment","mapping":[{"identity":"rim","map":".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"},{"identity":"ical","map":"COMMENT"}],"max":"1","min":0,"path":"AppointmentResponse.comment","short":"Additional comments","type":[{"code":"string"}]}]},"status":"draft","text":{"div":"
\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" AppointmentResponse IDomainResourceA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
+ Either the participantType or actor must be specified
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
\".\"\".\"\".\" identifier Σ0..*IdentifierExternal Ids for this item
\".\"\".\"\".\" appointment Σ1..1Reference(Appointment)Appointment this response relates to
\".\"\".\"\".\" start 0..1instantTime from appointment, or requested new start time
\".\"\".\"\".\" end 0..1instantTime from appointment, or requested new end time
\".\"\".\"\".\" participantType Σ0..*CodeableConceptRole of participant in the appointment
ParticipantType (Extensible)
\".\"\".\"\".\" actor Σ0..1Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location)Person, Location/HealthcareService or Device
\".\"\".\"\".\" participantStatus ?!Σ1..1codeaccepted | declined | tentative | in-process | completed | needs-action | entered-in-error
ParticipationStatus (Required)
\".\"\".\"\".\" comment 0..1stringAdditional comments

\"doco\" Documentation for this format
","status":"generated"},"type":"AppointmentResponse","url":"http://hl7.org/fhir/StructureDefinition/AppointmentResponse"}