FHIR IG analytics| Package | hl7.fhir.uv.xver-r4.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-Appointment.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:cancelationReason | 0..1 | CodeableConcept | R4: The coded reason for the appointment being cancelled (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.cancelationReason | |
 extension:patientInstruction | 0..1 | string | R4: Detailed information and instructions for the patient (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.patientInstruction | |
 status | ||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:status | 0..1 | code | R4: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.status Binding: R4AppointmentstatusForR3 (0.1.0) (required): The free/busy status of an appointment. | |
| indication | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:reasonReference | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4: Reason the appointment is to take place (resource) URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| incomingReferral | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:basedOn | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4: The service request this appointment is allocated to assess additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| participant | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:period | 0..1 | Period | R4: Participation period of the actor (new) URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.participant.period | |
| actor | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:actor | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4: actor URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "profile-Appointment",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.0/StructureDefinition/profile-Appointment",
"version": "0.1.0",
"name": "Profile_R4_Appointment_R3",
"title": "Cross-version Profile for R4.Appointment for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:03:29.5905075-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4 Appointment content to be represented via FHIR STU3 Appointment resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "3.0.2",
"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": "Appointment",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Appointment",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Appointment",
"path": "Appointment",
"short": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)",
"definition": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"min": 0,
"max": "*",
"base": {
"path": "Appointment",
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "app-3",
"severity": "error",
"human": "Only proposed or cancelled appointments can be missing start/end dates",
"expression": "(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))",
"xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled'))",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment"
},
{
"key": "app-2",
"severity": "error",
"human": "Either start and end are specified, or neither",
"expression": "start.empty() xor end.exists()",
"xpath": "((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Act[@moodCode <= 'INT']"
},
{
"identity": "ical",
"map": "VEVENT"
},
{
"identity": "w5",
"map": "workflow.scheduling"
}
]
},
{
"id": "Appointment.id",
"path": "Appointment.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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Appointment.meta",
"path": "Appointment.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": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Appointment.implicitRules",
"path": "Appointment.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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Appointment.language",
"path": "Appointment.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"id": "Appointment.text",
"path": "Appointment.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.",
"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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Appointment.contained",
"path": "Appointment.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.",
"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.",
"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": "Appointment.extension",
"path": "Appointment.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Appointment.extension:cancelationReason",
"path": "Appointment.extension",
"sliceName": "cancelationReason",
"short": "R4: The coded reason for the appointment being cancelled (new)",
"definition": "R4: `Appointment.cancelationReason` (new:CodeableConcept)",
"comment": "Element `Appointment.cancelationReason` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.cancelationReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.cancelationReason|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Appointment.extension:patientInstruction",
"path": "Appointment.extension",
"sliceName": "patientInstruction",
"short": "R4: Detailed information and instructions for the patient (new)",
"definition": "R4: `Appointment.patientInstruction` (new:string)",
"comment": "Element `Appointment.patientInstruction` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.patientInstruction` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.patientInstruction|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Appointment.modifierExtension",
"path": "Appointment.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.",
"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.",
"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": "Appointment.identifier",
"path": "Appointment.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this appointment 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 (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "ical",
"map": "UID"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Appointment.status",
"path": "Appointment.status",
"short": "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error",
"definition": "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.",
"comment": "If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.",
"min": 1,
"max": "1",
"base": {
"path": "Appointment.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AppointmentStatus"
}
],
"strength": "required",
"description": "The free/busy status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/appointmentstatus|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "SCH-25"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Appointment.status.id",
"path": "Appointment.status.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Appointment.status.extension",
"path": "Appointment.status.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Appointment.status.extension:status",
"path": "Appointment.status.extension",
"sliceName": "status",
"short": "R4: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist",
"definition": "R4: `Appointment.status`",
"comment": "Element `Appointment.status` is mapped to FHIR STU3 element `Appointment.status` as `SourceIsBroaderThanTarget`.\nThe target context `Appointment.status` is a modifier element, so this extension does not need to be defined as a modifier.\nIf the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.status|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Appointment.status.value",
"path": "Appointment.status.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for code",
"definition": "Primitive value for code",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex",
"valueString": "[^\\s]+([\\s]?[^\\s]+)*"
}
],
"_code": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:token"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:token"
}
]
}
}
]
},
{
"id": "Appointment.serviceCategory",
"path": "Appointment.serviceCategory",
"short": "A broad categorisation of the service that is to be performed during this appointment",
"definition": "A broad categorisation of the service that is to be performed during this appointment.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.serviceCategory",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-category"
}
],
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-category|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a, might be inferred from the ServiceDeliveryLocation"
}
]
},
{
"id": "Appointment.serviceType",
"path": "Appointment.serviceType",
"short": "The specific service that is to be performed during this appointment",
"definition": "The specific service that is to be performed during this appointment.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.serviceType",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-type"
}
],
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/service-type|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a, might be inferred from the ServiceDeliveryLocation"
}
]
},
{
"id": "Appointment.specialty",
"path": "Appointment.specialty",
"short": "The specialty of a practitioner that would be required to perform the service requested in this appointment",
"definition": "The specialty of a practitioner that would be required to perform the service requested in this appointment.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.specialty",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "specialty"
}
],
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109"
}
},
"mapping": [
{
"identity": "rim",
"map": ".performer.AssignedPerson.code"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Appointment.appointmentType",
"path": "Appointment.appointmentType",
"short": "The style of appointment or patient that has been booked in the slot (not service type)",
"definition": "The style of appointment or patient that has been booked in the slot (not service type).",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.appointmentType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "appointment-type"
}
],
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0276|2.8.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "ARQ-7"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "Appointment.reason",
"path": "Appointment.reason",
"short": "Reason this appointment is scheduled",
"definition": "The reason that this appointment is being scheduled. This is more clinical than administrative.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.reason",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ApptReason"
}
],
"strength": "preferred",
"description": "The Reason for the appointment to take place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-reason|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "AIS-3, SCH-7"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "Appointment.indication",
"path": "Appointment.indication",
"short": "Reason the appointment is to takes place (resource)",
"definition": "Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.indication",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[@typeCode = 'RSON'].observation"
}
]
},
{
"id": "Appointment.indication.id",
"path": "Appointment.indication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.indication.extension",
"path": "Appointment.indication.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Appointment.indication.extension:reasonReference",
"path": "Appointment.indication.extension",
"sliceName": "reasonReference",
"short": "R4: Reason the appointment is to take place (resource)",
"definition": "R4: `Appointment.reasonReference`",
"comment": "Element `Appointment.reasonReference` is mapped to FHIR STU3 element `Appointment.indication` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Appointment.reasonReference` with unmapped reference targets: ImmunizationRecommendation, Observation.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Appointment.indication.reference",
"path": "Appointment.indication.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.indication.identifier",
"path": "Appointment.indication.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "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.",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Appointment.indication.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Appointment.indication.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.priority",
"path": "Appointment.priority",
"short": "Used to make informed decisions if needing to re-prioritize",
"definition": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).",
"comment": "Seeking implementer feedback on this property and how interoperable it is.\r\rUsing an extension to record a codeableconcept for named values may be tested at a future connectathon.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.priority",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"mapping": [
{
"identity": "v2",
"map": "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity": "rim",
"map": ".priorityCode"
},
{
"identity": "ical",
"map": "PRIORITY"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "Appointment.description",
"path": "Appointment.description",
"short": "Shown on a subject line in a meeting request, or appointment list",
"definition": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".text"
},
{
"identity": "ical",
"map": "DESCRIPTION"
}
]
},
{
"id": "Appointment.supportingInformation",
"path": "Appointment.supportingInformation",
"short": "Additional information to support the appointment",
"definition": "Additional information to support the appointment provided when making the appointment.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.supportingInformation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[@typeCode = 'SPRT'].observation"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "Appointment.start",
"path": "Appointment.start",
"short": "When appointment is to take place",
"definition": "Date/Time that the appointment is to take place.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.start",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity": "rim",
"map": ".effectiveTime.low"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "Appointment.end",
"path": "Appointment.end",
"short": "When appointment is to conclude",
"definition": "Date/Time that the appointment is to conclude.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.end",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9"
},
{
"identity": "rim",
"map": ".effectiveTime.high"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "Appointment.minutesDuration",
"path": "Appointment.minutesDuration",
"short": "Can be less than start/end (e.g. estimate)",
"definition": "Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.minutesDuration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
],
"mapping": [
{
"identity": "rim",
"map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width"
}
]
},
{
"id": "Appointment.slot",
"path": "Appointment.slot",
"short": "The slots that this appointment is filling",
"definition": "The slots from the participants' schedules that will be filled by the appointment.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.slot",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Slot"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']"
}
]
},
{
"id": "Appointment.created",
"path": "Appointment.created",
"short": "The date that this appointment was initially created",
"definition": "The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.",
"comment": "This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.created",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".author.time"
}
]
},
{
"id": "Appointment.comment",
"path": "Appointment.comment",
"short": "Additional comments",
"definition": "Additional comments about the appointment.",
"comment": "Additional text to aid in facilitating the appointment. For instance, a comment might be, \"patient should proceed immediately to infusion room upon arrival\"\r\rWhere this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.comment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity": "ical",
"map": "COMMENT"
}
]
},
{
"id": "Appointment.incomingReferral",
"path": "Appointment.incomingReferral",
"short": "The ReferralRequest provided as information to allocate to the Encounter",
"definition": "The referral request this appointment is allocated to assess (incoming referral).",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.incomingReferral",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']"
}
]
},
{
"id": "Appointment.incomingReferral.id",
"path": "Appointment.incomingReferral.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.incomingReferral.extension",
"path": "Appointment.incomingReferral.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Appointment.incomingReferral.extension:basedOn",
"path": "Appointment.incomingReferral.extension",
"sliceName": "basedOn",
"short": "R4: The service request this appointment is allocated to assess additional types",
"definition": "R4: `Appointment.basedOn` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Appointment.basedOn` is mapped to FHIR STU3 element `Appointment.incomingReferral` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.basedOn` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Appointment.basedOn` with unmapped reference targets: ServiceRequest.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Appointment.incomingReferral.reference",
"path": "Appointment.incomingReferral.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.incomingReferral.identifier",
"path": "Appointment.incomingReferral.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "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.",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Appointment.incomingReferral.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Appointment.incomingReferral.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.participant",
"path": "Appointment.participant",
"short": "Participants involved in appointment",
"definition": "List of participants involved in the appointment.",
"min": 1,
"max": "*",
"base": {
"path": "Appointment.participant",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "app-1",
"severity": "error",
"human": "Either the type or actor on the participant SHALL be specified",
"expression": "type.exists() or actor.exists()",
"xpath": "(exists(f:type) or exists(f:actor))",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID, AIP, AIG, AIL"
},
{
"identity": "rim",
"map": "performer | reusableDevice | subject | location"
},
{
"identity": "ical",
"map": "ATTENDEE component to be created"
}
]
},
{
"id": "Appointment.participant.id",
"path": "Appointment.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.participant.extension",
"path": "Appointment.participant.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Appointment.participant.extension:period",
"path": "Appointment.participant.extension",
"sliceName": "period",
"short": "R4: Participation period of the actor (new)",
"definition": "R4: `Appointment.participant.period` (new:Period)",
"comment": "Element `Appointment.participant.period` has a context of Appointment.participant based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.participant.period` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.participant.period|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Appointment.participant.modifierExtension",
"path": "Appointment.participant.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 element, 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.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.participant.type",
"path": "Appointment.participant.type",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"comment": "The role of the participant can be used to declare what the actor will be doing in the scope of this 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 when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.participant.type",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipantType"
}
],
"strength": "extensible",
"description": "Role of participant in encounter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/encounter-participant-type|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "AIP-4, AIG-4"
},
{
"identity": "rim",
"map": "(performer | reusableDevice | subject | location).@typeCode"
},
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"id": "Appointment.participant.actor",
"path": "Appointment.participant.actor",
"short": "Person, Location/HealthcareService or Device",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.participant.actor",
"min": 0,
"max": "1"
},
"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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"
},
{
"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) where the participant type is not \"information-only\""
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "Appointment.participant.actor.id",
"path": "Appointment.participant.actor.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.participant.actor.extension",
"path": "Appointment.participant.actor.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Appointment.participant.actor.extension:actor",
"path": "Appointment.participant.actor.extension",
"sliceName": "actor",
"short": "R4: actor",
"definition": "R4: `Appointment.participant.actor`",
"comment": "Element `Appointment.participant.actor` is mapped to FHIR STU3 element `Appointment.participant.actor` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Appointment.participant.actor` with unmapped reference targets: PractitionerRole.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Appointment.participant.actor.reference",
"path": "Appointment.participant.actor.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.participant.actor.identifier",
"path": "Appointment.participant.actor.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "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.",
"comment": "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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Appointment.participant.actor.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Appointment.participant.actor.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.participant.required",
"path": "Appointment.participant.required",
"short": "required | optional | information-only",
"definition": "Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.participant.required",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipantRequired"
}
],
"strength": "required",
"description": "Is the Participant required to attend the appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participantrequired|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "(performer | reusableDevice | subject | location).@performInd"
},
{
"identity": "ical",
"map": "ROLE=REQ-PARTICIPANT (roleparam)"
}
]
},
{
"id": "Appointment.participant.status",
"path": "Appointment.participant.status",
"short": "accepted | declined | tentative | needs-action",
"definition": "Participation status of the actor.",
"min": 1,
"max": "1",
"base": {
"path": "Appointment.participant.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipationStatus"
}
],
"strength": "required",
"description": "The Participation status of an appointment.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/participationstatus|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "AIP-12, AIG-14"
},
{
"identity": "rim",
"map": "(performer | reusableDevice | subject | location).statusCode"
},
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
}
]
},
{
"id": "Appointment.requestedPeriod",
"path": "Appointment.requestedPeriod",
"short": "Potential date/time interval(s) requested to allocate the appointment within",
"definition": "A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.",
"comment": "This does not introduce a capacity for recurring appointments.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.requestedPeriod",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "ARQ-11"
},
{
"identity": "rim",
"map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Appointment",
"path": "Appointment"
},
{
"id": "Appointment.extension",
"path": "Appointment.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.extension:cancelationReason",
"path": "Appointment.extension",
"sliceName": "cancelationReason",
"short": "R4: The coded reason for the appointment being cancelled (new)",
"definition": "R4: `Appointment.cancelationReason` (new:CodeableConcept)",
"comment": "Element `Appointment.cancelationReason` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.cancelationReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.cancelationReason|0.1.0"
}
]
},
{
"id": "Appointment.extension:patientInstruction",
"path": "Appointment.extension",
"sliceName": "patientInstruction",
"short": "R4: Detailed information and instructions for the patient (new)",
"definition": "R4: `Appointment.patientInstruction` (new:string)",
"comment": "Element `Appointment.patientInstruction` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.patientInstruction` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.patientInstruction|0.1.0"
}
]
},
{
"id": "Appointment.status.extension",
"path": "Appointment.status.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.status.extension:status",
"path": "Appointment.status.extension",
"sliceName": "status",
"short": "R4: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist",
"definition": "R4: `Appointment.status`",
"comment": "Element `Appointment.status` is mapped to FHIR STU3 element `Appointment.status` as `SourceIsBroaderThanTarget`.\nThe target context `Appointment.status` is a modifier element, so this extension does not need to be defined as a modifier.\nIf the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.status|0.1.0"
}
]
},
{
"id": "Appointment.indication.extension",
"path": "Appointment.indication.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.indication.extension:reasonReference",
"path": "Appointment.indication.extension",
"sliceName": "reasonReference",
"short": "R4: Reason the appointment is to take place (resource)",
"definition": "R4: `Appointment.reasonReference`",
"comment": "Element `Appointment.reasonReference` is mapped to FHIR STU3 element `Appointment.indication` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Appointment.reasonReference` with unmapped reference targets: ImmunizationRecommendation, Observation.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Appointment.incomingReferral.extension",
"path": "Appointment.incomingReferral.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.incomingReferral.extension:basedOn",
"path": "Appointment.incomingReferral.extension",
"sliceName": "basedOn",
"short": "R4: The service request this appointment is allocated to assess additional types",
"definition": "R4: `Appointment.basedOn` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `Appointment.basedOn` is mapped to FHIR STU3 element `Appointment.incomingReferral` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.basedOn` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Appointment.basedOn` with unmapped reference targets: ServiceRequest.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Appointment.participant.extension",
"path": "Appointment.participant.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.participant.extension:period",
"path": "Appointment.participant.extension",
"sliceName": "period",
"short": "R4: Participation period of the actor (new)",
"definition": "R4: `Appointment.participant.period` (new:Period)",
"comment": "Element `Appointment.participant.period` has a context of Appointment.participant based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.participant.period` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Appointment.participant.period|0.1.0"
}
]
},
{
"id": "Appointment.participant.actor.extension",
"path": "Appointment.participant.actor.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.participant.actor.extension:actor",
"path": "Appointment.participant.actor.extension",
"sliceName": "actor",
"short": "R4: actor",
"definition": "R4: `Appointment.participant.actor`",
"comment": "Element `Appointment.participant.actor` is mapped to FHIR STU3 element `Appointment.participant.actor` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Appointment.participant.actor` with unmapped reference targets: PractitionerRole.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
}
]
}
}