FHIR IG analytics
| Package | hl7.fhir.uv.xver-r5.r4 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-Appointment.json |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/uv/xver-r5.r4/0.1.0/StructureDefinition-profile-Appointment.html |
| URL | http://hl7.org/fhir/5.0/StructureDefinition/profile-Appointment |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T16:04:42.9837594-05:00 |
| Name | Profile_R5_Appointment_R4 |
| Title | Cross-version Profile for R5.Appointment for use in FHIR R4 |
| Realm | uv |
| Authority | hl7 |
| Description | This cross-version profile allows R5 Appointment content to be represented via FHIR R4 Appointment resources. |
| Type | Appointment |
| Kind | resource |
Resources that use this resource
Resources that this resource uses
Narrative
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|
  Appointment | | 0..* | Appointment(4.0.1) | 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:class | | 0..* | CodeableConcept | R5: Classification when becoming an encounter (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class
|
| extension:reason | | 0..* | (Complex) | R5: Reason this appointment is scheduled additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason
|
| extension:replaces | | 0..* | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4(0.1.0) | Appointment) | R5: Appointment replaced by this Appointment (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces
|
| extension:virtualService | | 0..* | (Complex) | R5: Connection details of a virtual service (e.g. conference call) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.virtualService
|
| extension:previousAppointment | | 0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4(0.1.0) | Appointment) | R5: The previous appointment in a series (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.previousAppointment
|
| extension:originatingAppointment | | 0..1 | Reference(Cross-version Profile for R5.Appointment for use in FHIR R4(0.1.0) | Appointment) | R5: The originating appointment in a recurring set of appointments (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.originatingAppointment
|
| extension:account | | 0..* | Reference(Cross-version Profile for R5.Account for use in FHIR R4(0.1.0) | Account) | R5: The set of accounts that may be used for billing for this Appointment (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.account
|
| extension:cancellationDate | | 0..1 | dateTime | R5: When the appointment was cancelled (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationDate
|
| extension:subject | | 0..1 | Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group) | R5: The patient or group associated with the appointment (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.subject
|
| extension:recurrenceId | | 0..1 | positiveInt | R5: The sequence number in the recurrence (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceId
|
| extension:occurrenceChanged | | 0..1 | boolean | R5: Indicates that this appointment varies from a recurrence pattern (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.occurrenceChanged
|
 extension:recurrenceTemplate | | 0..* | (Complex) | R5: Details of the recurrence pattern/template used to generate occurrences (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceTemplate
|
 serviceType | | | | |
 Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
|
 extension:serviceType | | 0..* | Reference(Cross-version Profile for R5.HealthcareService for use in FHIR R4(0.1.0) | HealthcareService) | R5: serviceType additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.serviceType
|
| priority | | | | |
| Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
|
| extension:priority | | 0..1 | CodeableConcept | R5: priority additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.priority
Binding: v3.ActPriority (2018-08-12)  (example): Indicates the urgency of the appointment.
|
| comment | | | | |
| Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
|
| extension:note | | 0..* | Annotation | R5: note additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note
|
| patientInstruction | | | | |
| Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
|
| extension:patientInstruction | | 0..* | (Complex) | R5: patientInstruction additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.patientInstruction
|
| basedOn | | | | |
| Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
|
| extension:basedOn | | 0..* | Reference(Resource) | R5: The request this appointment is allocated to assess
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
|
| participant | | | | |
| actor | | | | |
| Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
|
| extension:actor | | 0..1 | Reference(Resource) | R5: The individual, device, location, or service participating in the appointment
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
|
| required | | | | |
| Slices for extension | | 0..* | Extension | Extension
Slice: Unordered, Open by value:url
|
| extension:required | | 0..1 | boolean | R5: The participant is required to attend (optional when false) additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.required
|
Documentation for this format |
Source1
{
"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-r5.r4"
},
{
"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",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
}
]
}
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/profile-Appointment",
"version": "0.1.0",
"name": "Profile_R5_Appointment_R4",
"title": "Cross-version Profile for R5.Appointment for use in FHIR R4",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:42.9837594-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 R5 Appointment content to be represented via FHIR R4 Appointment resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "ical",
"uri": "http://ietf.org/rfc/2445",
"name": "iCalendar"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern 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|4.0.1",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"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": "app-2",
"severity": "error",
"human": "Either start and end are specified, or neither",
"expression": "start.exists() = 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|4.0.1"
},
{
"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' | 'waitlist'))",
"xpath": "((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment|4.0.1"
},
{
"key": "app-4",
"severity": "error",
"human": "Cancelation reason is only used for appointments that have been cancelled, or no-show",
"expression": "Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')",
"xpath": "not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')",
"source": "http://hl7.org/fhir/StructureDefinition/Appointment|4.0.1"
},
{
"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|4.0.1"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource|4.0.1"
},
{
"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|4.0.1"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource|4.0.1"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Request"
},
{
"identity": "rim",
"map": "Act[@moodCode <= 'INT']"
},
{
"identity": "ical",
"map": "VEVENT"
}
]
},
{
"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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"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 might 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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages|4.0.1"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|4.0.1"
}
},
{
"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 can 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 information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:class",
"path": "Appointment.extension",
"sliceName": "class",
"short": "R5: Classification when becoming an encounter (new)",
"definition": "R5: `Appointment.class` (new:CodeableConcept)",
"comment": "Element `Appointment.class` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.class` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:reason",
"path": "Appointment.extension",
"sliceName": "reason",
"short": "R5: Reason this appointment is scheduled additional types",
"definition": "R5: `Appointment.reason` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Procedure), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation))",
"comment": "Element `Appointment.reason` is mapped to FHIR R4 element `Appointment.reasonCode` as `SourceIsBroaderThanTarget`.\nElement `Appointment.reason` is mapped to FHIR R4 element `Appointment.reasonReference` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.reason` do not cover the following types: CodeableReference.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:replaces",
"path": "Appointment.extension",
"sliceName": "replaces",
"short": "R5: Appointment replaced by this Appointment (new)",
"definition": "R5: `Appointment.replaces` (new:Reference(Appointment))",
"comment": "Element `Appointment.replaces` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.replaces` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:virtualService",
"path": "Appointment.extension",
"sliceName": "virtualService",
"short": "R5: Connection details of a virtual service (e.g. conference call) (new)",
"definition": "R5: `Appointment.virtualService` (new:VirtualServiceDetail)",
"comment": "Element `Appointment.virtualService` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.virtualService` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThere are two types of virtual meetings that often exist:\r\r* a persistent, virtual meeting room that can only be used for a single purpose at a time, \r* and a dynamic virtual meeting room that is generated on demand for a specific purpose.\r\rImplementers may consider using Location.virtualService for persistent meeting rooms.\r\rIf each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Appointment.participant BackboneElement.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.virtualService|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:previousAppointment",
"path": "Appointment.extension",
"sliceName": "previousAppointment",
"short": "R5: The previous appointment in a series (new)",
"definition": "R5: `Appointment.previousAppointment` (new:Reference(Appointment))",
"comment": "Element `Appointment.previousAppointment` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.previousAppointment` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThis property is intended for use when representing a series of related appointments. For example, in a nuclear medicine procedure, where there is an appointment for the injection of the isotopes, and then a subsequent appointment for the scan, the scan appointment would refer to the injection appointment via Appointment.previousAppointment. For representing recurring appointments, see the guidance on recurring vs. series appointments.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.previousAppointment|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:originatingAppointment",
"path": "Appointment.extension",
"sliceName": "originatingAppointment",
"short": "R5: The originating appointment in a recurring set of appointments (new)",
"definition": "R5: `Appointment.originatingAppointment` (new:Reference(Appointment))",
"comment": "Element `Appointment.originatingAppointment` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.originatingAppointment` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThis property is intended for use when representing a recurring set of related appointments.\r\rFor example, a patient undergoing physical therapy may have a recurring appointment every Tuesday and Thursday. Each occurrence of the set will refer to the originating appointment, which contains the recurring template information. For representing appointment series, see the guidance on recurring vs. series appointments.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.originatingAppointment|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:account",
"path": "Appointment.extension",
"sliceName": "account",
"short": "R5: The set of accounts that may be used for billing for this Appointment (new)",
"definition": "R5: `Appointment.account` (new:Reference(Account))",
"comment": "Element `Appointment.account` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.account` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThe specified account(s) could be those identified during pre-registration workflows in preparation for an upcoming Encounter.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.account|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:cancellationDate",
"path": "Appointment.extension",
"sliceName": "cancellationDate",
"short": "R5: When the appointment was cancelled (new)",
"definition": "R5: `Appointment.cancellationDate` (new:dateTime)",
"comment": "Element `Appointment.cancellationDate` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.cancellationDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nIf the appointment was cancelled multiple times, this would reflect the most recent cancellation.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationDate|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:subject",
"path": "Appointment.extension",
"sliceName": "subject",
"short": "R5: The patient or group associated with the appointment (new)",
"definition": "R5: `Appointment.subject` (new:Reference(Patient,Group))",
"comment": "Element `Appointment.subject` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.subject` has no mapping targets in FHIR R4. 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/5.0/StructureDefinition/extension-Appointment.subject|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:recurrenceId",
"path": "Appointment.extension",
"sliceName": "recurrenceId",
"short": "R5: The sequence number in the recurrence (new)",
"definition": "R5: `Appointment.recurrenceId` (new:positiveInt)",
"comment": "Element `Appointment.recurrenceId` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.recurrenceId` has no mapping targets in FHIR R4. 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/5.0/StructureDefinition/extension-Appointment.recurrenceId|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:occurrenceChanged",
"path": "Appointment.extension",
"sliceName": "occurrenceChanged",
"short": "R5: Indicates that this appointment varies from a recurrence pattern (new)",
"definition": "R5: `Appointment.occurrenceChanged` (new:boolean)",
"comment": "Element `Appointment.occurrenceChanged` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.occurrenceChanged` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nFor example, if a patient has physical therapy appointments every Tuesday and Thursday, but due to a national holiday, a single occurrence was rescheduled to a different day, while the rest of the recurring series remained on Tuesday / Thursday.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.occurrenceChanged|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.extension:recurrenceTemplate",
"path": "Appointment.extension",
"sliceName": "recurrenceTemplate",
"short": "R5: Details of the recurrence pattern/template used to generate occurrences (new)",
"definition": "R5: `Appointment.recurrenceTemplate` (new:BackboneElement)",
"comment": "Element `Appointment.recurrenceTemplate` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.recurrenceTemplate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceTemplate|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false,
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "ical",
"map": "UID"
}
]
},
{
"id": "Appointment.status",
"path": "Appointment.status",
"short": "proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AppointmentStatus"
}
],
"strength": "required",
"description": "The free/busy status of an appointment.",
"valueSet": "http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1"
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "SCH-25"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "ical",
"map": "STATUS"
}
]
},
{
"id": "Appointment.cancelationReason",
"path": "Appointment.cancelationReason",
"short": "The coded reason for the appointment being cancelled",
"definition": "The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.cancelationReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "cancelation-reason"
}
],
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/appointment-cancellation-reason|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.serviceCategory",
"path": "Appointment.serviceCategory",
"short": "A broad categorization of the service that is to be performed during this appointment",
"definition": "A broad categorization of the service that is to be performed during this appointment.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.serviceCategory",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-category"
}
],
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-category|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a, might be inferred from the ServiceDeliveryLocation"
},
{
"identity": "ical",
"map": "CATEGORIES"
}
]
},
{
"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.",
"comment": "For a provider to provider appointment the code \"FOLLOWUP\" may be appropriate, as this is expected to be discussing some patient that was seen in the past.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.serviceType",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "service-type"
}
],
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/service-type|4.0.1"
},
"mapping": [
{
"identity": "workflow",
"map": "Request.code"
},
{
"identity": "rim",
"map": "n/a, might be inferred from the ServiceDeliveryLocation"
}
]
},
{
"id": "Appointment.serviceType.id",
"path": "Appointment.serviceType.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.serviceType.extension",
"path": "Appointment.serviceType.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.serviceType.extension:serviceType",
"path": "Appointment.serviceType.extension",
"sliceName": "serviceType",
"short": "R5: serviceType additional types",
"definition": "R5: `Appointment.serviceType` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/HealthcareService)) additional types from child elements (reference)",
"comment": "Element `Appointment.serviceType` is mapped to FHIR R4 element `Appointment.serviceType` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.serviceType` do not cover the following types: CodeableReference.\nThe mappings for `Appointment.serviceType` do not cover the following types based on type expansion: reference.\nFor a provider to provider appointment the code \"FOLLOWUP\" may be appropriate, as this is expected to be discussing some patient that was seen in the past.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.serviceType|0.1.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.serviceType.coding",
"path": "Appointment.serviceType.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id": "Appointment.serviceType.text",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Appointment.serviceType.text",
"short": "Plain text representation of the concept",
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "specialty"
}
],
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "rim",
"map": ".performer.AssignedPerson.code"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "appointment-type"
}
],
"strength": "preferred",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0276|3.0.0"
},
"mapping": [
{
"identity": "v2",
"map": "ARQ-7"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "ical",
"map": "CLASSIFICATION"
}
]
},
{
"id": "Appointment.reasonCode",
"path": "Appointment.reasonCode",
"short": "Coded reason this appointment is scheduled",
"definition": "The coded reason that this appointment is being scheduled. This is more clinical than administrative.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1"
},
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonCode"
},
{
"identity": "v2",
"map": "AIS-3, SCH-7"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "Appointment.reasonReference",
"path": "Appointment.reasonReference",
"short": "Reason the appointment is to take 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.reasonReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Condition|4.0.1",
"http://hl7.org/fhir/StructureDefinition/Procedure|4.0.1",
"http://hl7.org/fhir/StructureDefinition/Observation|4.0.1",
"http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonReference"
},
{
"identity": "rim",
"map": ".inboundRelationship[@typeCode = 'RSON'].observation"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.priority"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "v2",
"map": "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity": "rim",
"map": ".priorityCode"
},
{
"identity": "ical",
"map": "PRIORITY"
}
]
},
{
"id": "Appointment.priority.id",
"path": "Appointment.priority.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.priority.extension",
"path": "Appointment.priority.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.priority.extension:priority",
"path": "Appointment.priority.extension",
"sliceName": "priority",
"short": "R5: priority additional types",
"definition": "R5: `Appointment.priority` additional types (CodeableConcept) additional types from child elements (coding, text)",
"comment": "Element `Appointment.priority` is mapped to FHIR R4 element `Appointment.priority` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.priority` do not cover the following types: CodeableConcept.\nThe mappings for `Appointment.priority` do not cover the following types based on type expansion: coding, text.\nSeeking 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": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.priority|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.priority.value",
"path": "Appointment.priority.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for unsignedInt",
"definition": "Primitive value for unsignedInt",
"min": 0,
"max": "1",
"base": {
"path": "integer.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[0]|([1-9][0-9]*)"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".text"
},
{
"identity": "ical",
"map": "SUMMARY"
}
]
},
{
"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|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "rim",
"map": ".inboundRelationship[@typeCode = 'SPRT'].observation"
},
{
"identity": "ical",
"map": "ATTACH"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.init"
},
{
"identity": "v2",
"map": "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity": "rim",
"map": ".effectiveTime.low"
},
{
"identity": "ical",
"map": "DTSTART"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.done[x]"
},
{
"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": "ical",
"map": "DTEND"
}
]
},
{
"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. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.minutesDuration",
"min": 0,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"identity": "rim",
"map": ".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width"
},
{
"identity": "ical",
"map": "DURATION (e.g. PT15M)"
}
]
},
{
"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|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.authoredOn"
},
{
"identity": "rim",
"map": ".author.time"
},
{
"identity": "ical",
"map": "CREATED"
}
]
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.note"
},
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity": "ical",
"map": "DESCRIPTION (for internal use)"
}
]
},
{
"id": "Appointment.comment.id",
"path": "Appointment.comment.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.comment.extension",
"path": "Appointment.comment.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.comment.extension:note",
"path": "Appointment.comment.extension",
"sliceName": "note",
"short": "R5: note additional types",
"definition": "R5: `Appointment.note` additional types (Annotation) additional types from child elements (time)",
"comment": "Element `Appointment.note` is mapped to FHIR R4 element `Appointment.comment` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.note` do not cover the following types: Annotation.\nThe mappings for `Appointment.note` do not cover the following types based on type expansion: time.\nAdditional text to aid in facilitating the appointment. For instance, a note 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.\r\rTypically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.comment.value",
"path": "Appointment.comment.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "The actual value",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"maxLength": 1048576,
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.patientInstruction",
"path": "Appointment.patientInstruction",
"short": "Detailed information and instructions for the patient",
"definition": "While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.patientInstruction",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value"
},
{
"identity": "ical",
"map": "DESCRIPTION (for patient use)"
}
]
},
{
"id": "Appointment.patientInstruction.id",
"path": "Appointment.patientInstruction.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.patientInstruction.extension",
"path": "Appointment.patientInstruction.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.patientInstruction.extension:patientInstruction",
"path": "Appointment.patientInstruction.extension",
"sliceName": "patientInstruction",
"short": "R5: patientInstruction additional types",
"definition": "R5: `Appointment.patientInstruction` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/DocumentReference), CodeableReference(http://hl7.org/fhir/StructureDefinition/Binary), CodeableReference(http://hl7.org/fhir/StructureDefinition/Communication))",
"comment": "Element `Appointment.patientInstruction` is mapped to FHIR R4 element `Appointment.patientInstruction` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.patientInstruction` do not cover the following types: CodeableReference.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.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() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.patientInstruction.value",
"path": "Appointment.patientInstruction.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "The actual value",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[ \\r\\n\\t\\S]+"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"maxLength": 1048576,
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.basedOn",
"path": "Appointment.basedOn",
"short": "The service request this appointment is allocated to assess",
"definition": "The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).",
"alias": [
"incomingReferral"
],
"min": 0,
"max": "*",
"base": {
"path": "Appointment.basedOn",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ServiceRequest|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.basedOn"
},
{
"identity": "rim",
"map": ".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']"
}
]
},
{
"id": "Appointment.basedOn.id",
"path": "Appointment.basedOn.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.basedOn.extension",
"path": "Appointment.basedOn.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.basedOn.extension:basedOn",
"path": "Appointment.basedOn.extension",
"sliceName": "basedOn",
"short": "R5: The request this appointment is allocated to assess",
"definition": "R5: `Appointment.basedOn`",
"comment": "Element `Appointment.basedOn` is mapped to FHIR R4 element `Appointment.basedOn` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Appointment.basedOn` with unmapped reference targets: CarePlan, DeviceRequest, MedicationRequest.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/alternate-reference|5.2.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.basedOn.reference",
"path": "Appointment.basedOn.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"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.basedOn.type",
"path": "Appointment.basedOn.type",
"short": "Type the reference refers to (e.g. \"Patient\")",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}
],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.basedOn.identifier",
"path": "Appointment.basedOn.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Appointment.basedOn.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Appointment.basedOn.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"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": "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|4.0.1"
},
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.performer, Request.subject"
},
{
"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": "Unique id for inter-element referencing",
"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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.participant.extension",
"path": "Appointment.participant.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 element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Appointment.participant.modifierExtension",
"path": "Appointment.participant.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipantType"
}
],
"strength": "extensible",
"description": "Role of participant in encounter.",
"valueSet": "http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1"
},
"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|4.0.1",
"http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1",
"http://hl7.org/fhir/StructureDefinition/Device|4.0.1",
"http://hl7.org/fhir/StructureDefinition/HealthcareService|4.0.1",
"http://hl7.org/fhir/StructureDefinition/Location|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.who"
},
{
"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\""
}
]
},
{
"id": "Appointment.participant.actor.id",
"path": "Appointment.participant.actor.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.participant.actor.extension:actor",
"path": "Appointment.participant.actor.extension",
"sliceName": "actor",
"short": "R5: The individual, device, location, or service participating in the appointment",
"definition": "R5: `Appointment.participant.actor`",
"comment": "Element `Appointment.participant.actor` is mapped to FHIR R4 element `Appointment.participant.actor` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Appointment.participant.actor` with unmapped reference targets: CareTeam, Group.\nWhere a CareTeam is provided, this does not imply that the entire team is included, just a single member from the group with the appropriate role. Where multiple members are required, please include the CareTeam the required number of times.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/alternate-reference|5.2.0"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"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"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.participant.actor.type",
"path": "Appointment.participant.actor.type",
"short": "Type the reference refers to (e.g. \"Patient\")",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}
],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"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 target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Appointment.participant.required",
"path": "Appointment.participant.required",
"short": "required | optional | information-only",
"definition": "Whether this participant is required to be present at the meeting. This covers a use-case where two 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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"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.",
"valueSet": "http://hl7.org/fhir/ValueSet/participantrequired|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "(performer | reusableDevice | subject | location).@performInd"
},
{
"identity": "ical",
"map": "ROLE=REQ-PARTICIPANT (roleparam)"
}
]
},
{
"id": "Appointment.participant.required.id",
"path": "Appointment.participant.required.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": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.participant.required.extension",
"path": "Appointment.participant.required.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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.participant.required.extension:required",
"path": "Appointment.participant.required.extension",
"sliceName": "required",
"short": "R5: The participant is required to attend (optional when false) additional types",
"definition": "R5: `Appointment.participant.required` additional types (boolean) additional types from child elements (value)",
"comment": "Element `Appointment.participant.required` is mapped to FHIR R4 element `Appointment.participant.required` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.participant.required` do not cover the following types: boolean.\nThe mappings for `Appointment.participant.required` do not cover the following types based on type expansion: value.\nFor the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.required|0.1.0"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
},
{
"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|4.0.1"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Appointment.participant.required.value",
"path": "Appointment.participant.required.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-fhir-type",
"valueUrl": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/regex",
"valueString": "[^\\s]+(\\s[^\\s]+)*"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false
},
{
"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"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ParticipationStatus"
}
],
"strength": "required",
"description": "The Participation status of an appointment.",
"valueSet": "http://hl7.org/fhir/ValueSet/participationstatus|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "AIP-12, AIG-14"
},
{
"identity": "rim",
"map": "(performer | reusableDevice | subject | location).statusCode"
},
{
"identity": "ical",
"map": "ATTENDEE;CN=\"John Doe\";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)"
}
]
},
{
"id": "Appointment.participant.period",
"path": "Appointment.participant.period",
"short": "Participation period of the actor",
"definition": "Participation period of the actor.",
"min": 0,
"max": "1",
"base": {
"path": "Appointment.participant.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.\n\nThe duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.",
"comment": "This does not introduce a capacity for recurring appointments.",
"min": 0,
"max": "*",
"base": {
"path": "Appointment.requestedPeriod",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element|4.0.1"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence[x]"
},
{
"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:class",
"path": "Appointment.extension",
"sliceName": "class",
"short": "R5: Classification when becoming an encounter (new)",
"definition": "R5: `Appointment.class` (new:CodeableConcept)",
"comment": "Element `Appointment.class` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.class` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:reason",
"path": "Appointment.extension",
"sliceName": "reason",
"short": "R5: Reason this appointment is scheduled additional types",
"definition": "R5: `Appointment.reason` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Condition), CodeableReference(http://hl7.org/fhir/StructureDefinition/Procedure), CodeableReference(http://hl7.org/fhir/StructureDefinition/Observation), CodeableReference(http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation))",
"comment": "Element `Appointment.reason` is mapped to FHIR R4 element `Appointment.reasonCode` as `SourceIsBroaderThanTarget`.\nElement `Appointment.reason` is mapped to FHIR R4 element `Appointment.reasonReference` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.reason` do not cover the following types: CodeableReference.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.reason|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:replaces",
"path": "Appointment.extension",
"sliceName": "replaces",
"short": "R5: Appointment replaced by this Appointment (new)",
"definition": "R5: `Appointment.replaces` (new:Reference(Appointment))",
"comment": "Element `Appointment.replaces` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.replaces` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.replaces|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:virtualService",
"path": "Appointment.extension",
"sliceName": "virtualService",
"short": "R5: Connection details of a virtual service (e.g. conference call) (new)",
"definition": "R5: `Appointment.virtualService` (new:VirtualServiceDetail)",
"comment": "Element `Appointment.virtualService` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.virtualService` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThere are two types of virtual meetings that often exist:\r\r* a persistent, virtual meeting room that can only be used for a single purpose at a time, \r* and a dynamic virtual meeting room that is generated on demand for a specific purpose.\r\rImplementers may consider using Location.virtualService for persistent meeting rooms.\r\rIf each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Appointment.participant BackboneElement.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.virtualService|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:previousAppointment",
"path": "Appointment.extension",
"sliceName": "previousAppointment",
"short": "R5: The previous appointment in a series (new)",
"definition": "R5: `Appointment.previousAppointment` (new:Reference(Appointment))",
"comment": "Element `Appointment.previousAppointment` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.previousAppointment` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThis property is intended for use when representing a series of related appointments. For example, in a nuclear medicine procedure, where there is an appointment for the injection of the isotopes, and then a subsequent appointment for the scan, the scan appointment would refer to the injection appointment via Appointment.previousAppointment. For representing recurring appointments, see the guidance on recurring vs. series appointments.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.previousAppointment|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:originatingAppointment",
"path": "Appointment.extension",
"sliceName": "originatingAppointment",
"short": "R5: The originating appointment in a recurring set of appointments (new)",
"definition": "R5: `Appointment.originatingAppointment` (new:Reference(Appointment))",
"comment": "Element `Appointment.originatingAppointment` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.originatingAppointment` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThis property is intended for use when representing a recurring set of related appointments.\r\rFor example, a patient undergoing physical therapy may have a recurring appointment every Tuesday and Thursday. Each occurrence of the set will refer to the originating appointment, which contains the recurring template information. For representing appointment series, see the guidance on recurring vs. series appointments.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.originatingAppointment|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:account",
"path": "Appointment.extension",
"sliceName": "account",
"short": "R5: The set of accounts that may be used for billing for this Appointment (new)",
"definition": "R5: `Appointment.account` (new:Reference(Account))",
"comment": "Element `Appointment.account` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.account` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nThe specified account(s) could be those identified during pre-registration workflows in preparation for an upcoming Encounter.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.account|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:cancellationDate",
"path": "Appointment.extension",
"sliceName": "cancellationDate",
"short": "R5: When the appointment was cancelled (new)",
"definition": "R5: `Appointment.cancellationDate` (new:dateTime)",
"comment": "Element `Appointment.cancellationDate` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.cancellationDate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nIf the appointment was cancelled multiple times, this would reflect the most recent cancellation.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.cancellationDate|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:subject",
"path": "Appointment.extension",
"sliceName": "subject",
"short": "R5: The patient or group associated with the appointment (new)",
"definition": "R5: `Appointment.subject` (new:Reference(Patient,Group))",
"comment": "Element `Appointment.subject` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.subject` has no mapping targets in FHIR R4. 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/5.0/StructureDefinition/extension-Appointment.subject|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:recurrenceId",
"path": "Appointment.extension",
"sliceName": "recurrenceId",
"short": "R5: The sequence number in the recurrence (new)",
"definition": "R5: `Appointment.recurrenceId` (new:positiveInt)",
"comment": "Element `Appointment.recurrenceId` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.recurrenceId` has no mapping targets in FHIR R4. 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/5.0/StructureDefinition/extension-Appointment.recurrenceId|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:occurrenceChanged",
"path": "Appointment.extension",
"sliceName": "occurrenceChanged",
"short": "R5: Indicates that this appointment varies from a recurrence pattern (new)",
"definition": "R5: `Appointment.occurrenceChanged` (new:boolean)",
"comment": "Element `Appointment.occurrenceChanged` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.occurrenceChanged` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nFor example, if a patient has physical therapy appointments every Tuesday and Thursday, but due to a national holiday, a single occurrence was rescheduled to a different day, while the rest of the recurring series remained on Tuesday / Thursday.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.occurrenceChanged|0.1.0"
]
}
]
},
{
"id": "Appointment.extension:recurrenceTemplate",
"path": "Appointment.extension",
"sliceName": "recurrenceTemplate",
"short": "R5: Details of the recurrence pattern/template used to generate occurrences (new)",
"definition": "R5: `Appointment.recurrenceTemplate` (new:BackboneElement)",
"comment": "Element `Appointment.recurrenceTemplate` has a context of Appointment based on following the parent source element upwards and mapping to `Appointment`.\nElement `Appointment.recurrenceTemplate` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.recurrenceTemplate|0.1.0"
]
}
]
},
{
"id": "Appointment.serviceType.extension",
"path": "Appointment.serviceType.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.serviceType.extension:serviceType",
"path": "Appointment.serviceType.extension",
"sliceName": "serviceType",
"short": "R5: serviceType additional types",
"definition": "R5: `Appointment.serviceType` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/HealthcareService)) additional types from child elements (reference)",
"comment": "Element `Appointment.serviceType` is mapped to FHIR R4 element `Appointment.serviceType` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.serviceType` do not cover the following types: CodeableReference.\nThe mappings for `Appointment.serviceType` do not cover the following types based on type expansion: reference.\nFor a provider to provider appointment the code \"FOLLOWUP\" may be appropriate, as this is expected to be discussing some patient that was seen in the past.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.serviceType|0.1.0"
]
}
]
},
{
"id": "Appointment.priority.extension",
"path": "Appointment.priority.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.priority.extension:priority",
"path": "Appointment.priority.extension",
"sliceName": "priority",
"short": "R5: priority additional types",
"definition": "R5: `Appointment.priority` additional types (CodeableConcept) additional types from child elements (coding, text)",
"comment": "Element `Appointment.priority` is mapped to FHIR R4 element `Appointment.priority` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.priority` do not cover the following types: CodeableConcept.\nThe mappings for `Appointment.priority` do not cover the following types based on type expansion: coding, text.\nSeeking 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": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.priority|0.1.0"
]
}
]
},
{
"id": "Appointment.comment.extension",
"path": "Appointment.comment.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.comment.extension:note",
"path": "Appointment.comment.extension",
"sliceName": "note",
"short": "R5: note additional types",
"definition": "R5: `Appointment.note` additional types (Annotation) additional types from child elements (time)",
"comment": "Element `Appointment.note` is mapped to FHIR R4 element `Appointment.comment` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.note` do not cover the following types: Annotation.\nThe mappings for `Appointment.note` do not cover the following types based on type expansion: time.\nAdditional text to aid in facilitating the appointment. For instance, a note 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.\r\rTypically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note|0.1.0"
]
}
]
},
{
"id": "Appointment.patientInstruction.extension",
"path": "Appointment.patientInstruction.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.patientInstruction.extension:patientInstruction",
"path": "Appointment.patientInstruction.extension",
"sliceName": "patientInstruction",
"short": "R5: patientInstruction additional types",
"definition": "R5: `Appointment.patientInstruction` additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/DocumentReference), CodeableReference(http://hl7.org/fhir/StructureDefinition/Binary), CodeableReference(http://hl7.org/fhir/StructureDefinition/Communication))",
"comment": "Element `Appointment.patientInstruction` is mapped to FHIR R4 element `Appointment.patientInstruction` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.patientInstruction` do not cover the following types: CodeableReference.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.patientInstruction|0.1.0"
]
}
]
},
{
"id": "Appointment.basedOn.extension",
"path": "Appointment.basedOn.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.basedOn.extension:basedOn",
"path": "Appointment.basedOn.extension",
"sliceName": "basedOn",
"short": "R5: The request this appointment is allocated to assess",
"definition": "R5: `Appointment.basedOn`",
"comment": "Element `Appointment.basedOn` is mapped to FHIR R4 element `Appointment.basedOn` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Appointment.basedOn` with unmapped reference targets: CarePlan, DeviceRequest, MedicationRequest.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/alternate-reference|5.2.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": "R5: The individual, device, location, or service participating in the appointment",
"definition": "R5: `Appointment.participant.actor`",
"comment": "Element `Appointment.participant.actor` is mapped to FHIR R4 element `Appointment.participant.actor` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Appointment.participant.actor` with unmapped reference targets: CareTeam, Group.\nWhere a CareTeam is provided, this does not imply that the entire team is included, just a single member from the group with the appropriate role. Where multiple members are required, please include the CareTeam the required number of times.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/alternate-reference|5.2.0"
]
}
]
},
{
"id": "Appointment.participant.required.extension",
"path": "Appointment.participant.required.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Appointment.participant.required.extension:required",
"path": "Appointment.participant.required.extension",
"sliceName": "required",
"short": "R5: The participant is required to attend (optional when false) additional types",
"definition": "R5: `Appointment.participant.required` additional types (boolean) additional types from child elements (value)",
"comment": "Element `Appointment.participant.required` is mapped to FHIR R4 element `Appointment.participant.required` as `SourceIsBroaderThanTarget`.\nThe mappings for `Appointment.participant.required` do not cover the following types: boolean.\nThe mappings for `Appointment.participant.required` do not cover the following types based on type expansion: value.\nFor the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.participant.required|0.1.0"
]
}
]
}
]
}
}
FHIR
FHIRsmith