2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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
Profile for appointmentresponse
{
"resourceType": "Profile",
"id": "AppointmentResponse",
"meta": {
"lastUpdated": "2015-02-23T09:07:27.665+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/Profile/AppointmentResponse",
"name": "AppointmentResponse",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base Profile for AppointmentResponse Resource",
"status": "draft",
"date": "2015-02-23T09:07:27+11:00",
"mapping": [
{
"identity": "ical",
"uri": "http://www.ietf.org/rfc/rfc2445.txt",
"name": "iCalendar"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "AppointmentResponse",
"snapshot": {
"element": [
{
"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": 1,
"max": "1",
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
}
]
},
{
"path": "AppointmentResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. 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. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"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",
"type": [
{
"code": "Meta"
}
]
},
{
"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",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"description": "A human language",
"referenceUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"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.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AppointmentResponse.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this appointment concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AppointmentResponse.appointment",
"short": "Parent appointment that this response is replying to",
"definition": "Parent appointment that this response is replying to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Appointment"
}
]
},
{
"path": "AppointmentResponse.participantType",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ParticipantType",
"isExtensible": true,
"conformance": "preferred",
"description": "Role of participant in encounter",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"path": "AppointmentResponse.individual",
"short": "A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device",
"definition": "A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device.",
"comments": "Should this be multiple? And move to a child enitity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Any"
}
],
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
},
{
"path": "AppointmentResponse.participantStatus",
"short": "accepted | declined | tentative | in-process | completed | needs-action",
"definition": "Participation status of the Patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ParticipantStatus",
"isExtensible": false,
"conformance": "required",
"description": "The Participation status of an appointment",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/participantstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
}
]
},
{
"path": "AppointmentResponse.comment",
"short": "Additional comments about the appointment",
"definition": "Additional comments about the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
}
]
},
{
"path": "AppointmentResponse.start",
"short": "Date/Time that the appointment is to take place",
"definition": "Date/Time that the appointment is to take place.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "AppointmentResponse.end",
"short": "Date/Time that the appointment is to conclude",
"definition": "Date/Time that the appointment is to conclude.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "AppointmentResponse.lastModifiedBy",
"short": "Who recorded the appointment response",
"definition": "Who recorded the appointment response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/RelatedPerson"
}
],
"mapping": [
{
"identity": "v2",
"map": "IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"
}
]
},
{
"path": "AppointmentResponse.lastModified",
"short": "Date when the response was recorded or last updated",
"definition": "Date when the response was recorded or last updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "ical",
"map": "DTSTAMP"
},
{
"identity": "v2",
"map": "IAM-20-Statused at Date/Time"
}
]
}
]
},
"differential": {
"element": [
{
"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": 1,
"max": "1",
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
}
]
},
{
"path": "AppointmentResponse.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this appointment concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AppointmentResponse.appointment",
"short": "Parent appointment that this response is replying to",
"definition": "Parent appointment that this response is replying to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Appointment"
}
]
},
{
"path": "AppointmentResponse.participantType",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ParticipantType",
"isExtensible": true,
"conformance": "preferred",
"description": "Role of participant in encounter",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"path": "AppointmentResponse.individual",
"short": "A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device",
"definition": "A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device.",
"comments": "Should this be multiple? And move to a child enitity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Any"
}
],
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
},
{
"path": "AppointmentResponse.participantStatus",
"short": "accepted | declined | tentative | in-process | completed | needs-action",
"definition": "Participation status of the Patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ParticipantStatus",
"isExtensible": false,
"conformance": "required",
"description": "The Participation status of an appointment",
"referenceReference": {
"reference": "http://hl7.org/fhir/vs/participantstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
}
]
},
{
"path": "AppointmentResponse.comment",
"short": "Additional comments about the appointment",
"definition": "Additional comments about the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
}
]
},
{
"path": "AppointmentResponse.start",
"short": "Date/Time that the appointment is to take place",
"definition": "Date/Time that the appointment is to take place.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "AppointmentResponse.end",
"short": "Date/Time that the appointment is to conclude",
"definition": "Date/Time that the appointment is to conclude.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "AppointmentResponse.lastModifiedBy",
"short": "Who recorded the appointment response",
"definition": "Who recorded the appointment response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/Profile/RelatedPerson"
}
],
"mapping": [
{
"identity": "v2",
"map": "IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"
}
]
},
{
"path": "AppointmentResponse.lastModified",
"short": "Date when the response was recorded or last updated",
"definition": "Date when the response was recorded or last updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "ical",
"map": "DTSTAMP"
},
{
"identity": "v2",
"map": "IAM-20-Statused at Date/Time"
}
]
}
]
}
}
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 DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:18+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change