STU 3 Ballot
WorkflowThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for appointmentresponse
{
"resourceType": "StructureDefinition",
"id": "AppointmentResponse",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"name": "AppointmentResponse",
"status": "draft",
"publisher": "Health Level Seven International (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"date": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for AppointmentResponse Resource",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "ical",
"uri": "http://www.ietf.org/rfc/rfc2445.txt",
"name": "iCalendar"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "AppointmentResponse",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "AppointmentResponse",
"path": "AppointmentResponse",
"short": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection",
"definition": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
},
{
"key": "apr-1",
"severity": "error",
"human": "Either the participantType or actor must be specified",
"expression": "participantType.exists() or actor.exists()",
"xpath": "(exists(f:participantType) or exists(f:actor))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Appointment[@moodCode <= 'PRMS']"
},
{
"identity": "ical",
"map": "VEVENT"
},
{
"identity": "w5",
"map": "workflow.scheduling"
}
]
},
{
"id": "AppointmentResponse.id",
"path": "AppointmentResponse.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "AppointmentResponse.meta",
"path": "AppointmentResponse.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "AppointmentResponse.implicitRules",
"path": "AppointmentResponse.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "AppointmentResponse.language",
"path": "AppointmentResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "AppointmentResponse.text",
"path": "AppointmentResponse.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comments": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "AppointmentResponse.contained",
"path": "AppointmentResponse.contained",
"short": "Contained, inline Resources",
"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.",
"comments": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AppointmentResponse.extension",
"path": "AppointmentResponse.extension",
"short": "Additional Content defined by implementations",
"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.",
"comments": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AppointmentResponse.modifierExtension",
"path": "AppointmentResponse.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"comments": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AppointmentResponse.identifier",
"path": "AppointmentResponse.identifier",
"short": "External Ids for this item",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "ical",
"map": "UID"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "AppointmentResponse.appointment",
"path": "AppointmentResponse.appointment",
"short": "Appointment this response relates to",
"definition": "Appointment that this response is replying to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "scheduleRequest.Appointment[@moodCode <= 'RQO']"
}
]
},
{
"id": "AppointmentResponse.start",
"path": "AppointmentResponse.start",
"short": "Time from appointment, or requested new start time",
"definition": "Date/Time that the appointment is to take place, or requested new start time.",
"comments": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.low"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "AppointmentResponse.end",
"path": "AppointmentResponse.end",
"short": "Time from appointment, or requested new end time",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "AppointmentResponse.participantType",
"path": "AppointmentResponse.participantType",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"comments": "The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment.\n\nIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\n\nThis value MUST be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Role of participant in encounter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-participant-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "performer.person.@classCode | reusableDevice.manufacturedDevice.@classCode | subject.patient.@classCode | location.serviceDeliveryLocation.@classCode"
},
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"id": "AppointmentResponse.actor",
"path": "AppointmentResponse.actor",
"short": "Person, Location/HealthcareService or Device",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"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"
}
]
},
{
"id": "AppointmentResponse.participantStatus",
"path": "AppointmentResponse.participantStatus",
"short": "accepted | declined | tentative | in-process | completed | needs-action | entered-in-error",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The Participation status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participationstatus"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
}
]
},
{
"id": "AppointmentResponse.comment",
"path": "AppointmentResponse.comment",
"short": "Additional comments",
"definition": "Additional comments about the appointment.",
"comments": "This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".subjectOf.observationEvent[code=\"annotation\"].value"
},
{
"identity": "ical",
"map": "COMMENT"
}
]
}
]
},
"differential": {
"element": [
{
"id": "AppointmentResponse",
"path": "AppointmentResponse",
"short": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection",
"definition": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "apr-1",
"severity": "error",
"human": "Either the participantType or actor must be specified",
"expression": "participantType.exists() or actor.exists()",
"xpath": "(exists(f:participantType) or exists(f:actor))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Appointment[@moodCode <= 'PRMS']"
},
{
"identity": "ical",
"map": "VEVENT"
},
{
"identity": "w5",
"map": "workflow.scheduling"
}
]
},
{
"id": "AppointmentResponse.identifier",
"path": "AppointmentResponse.identifier",
"short": "External Ids for this item",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "ical",
"map": "UID"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "AppointmentResponse.appointment",
"path": "AppointmentResponse.appointment",
"short": "Appointment this response relates to",
"definition": "Appointment that this response is replying to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "scheduleRequest.Appointment[@moodCode <= 'RQO']"
}
]
},
{
"id": "AppointmentResponse.start",
"path": "AppointmentResponse.start",
"short": "Time from appointment, or requested new start time",
"definition": "Date/Time that the appointment is to take place, or requested new start time.",
"comments": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.low"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "AppointmentResponse.end",
"path": "AppointmentResponse.end",
"short": "Time from appointment, or requested new end time",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "AppointmentResponse.participantType",
"path": "AppointmentResponse.participantType",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"comments": "The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment.\n\nIf the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.\n\nThis value MUST be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Role of participant in encounter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-participant-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "performer.person.@classCode | reusableDevice.manufacturedDevice.@classCode | subject.patient.@classCode | location.serviceDeliveryLocation.@classCode"
},
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"id": "AppointmentResponse.actor",
"path": "AppointmentResponse.actor",
"short": "Person, Location/HealthcareService or Device",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"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"
}
]
},
{
"id": "AppointmentResponse.participantStatus",
"path": "AppointmentResponse.participantStatus",
"short": "accepted | declined | tentative | in-process | completed | needs-action | entered-in-error",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The Participation status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participationstatus"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
}
]
},
{
"id": "AppointmentResponse.comment",
"path": "AppointmentResponse.comment",
"short": "Additional comments",
"definition": "Additional comments about the appointment.",
"comments": "This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".subjectOf.observationEvent[code=\"annotation\"].value"
},
{
"identity": "ical",
"map": "COMMENT"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change