Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Active as of 2024-07-17 |
Definitions for the Interweave-Appointment resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Appointment | |
2. Appointment.id | |
Must Support | true |
3. Appointment.meta | |
Control | 0..? |
4. Appointment.meta.versionId | |
Control | 0..? |
Must Support | true |
5. Appointment.meta.lastUpdated | |
Control | 0..? |
Must Support | true |
6. Appointment.meta.profile | |
Control | 0..? |
Must Support | true |
7. Appointment.meta.security | |
Control | 0..? |
8. Appointment.meta.tag | |
Control | 0..? |
Slicing | This element introduces a set of slices on Appointment.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
9. Appointment.meta.tag:Source | |
SliceName | Source |
Control | 0..1 |
Must Support | true |
10. Appointment.meta.tag:Source.system | |
Control | 1..? |
Fixed Value | https://yhcr.nhs.uk/Source |
11. Appointment.meta.tag:Source.code | |
Control | 1..? |
Must Support | true |
12. Appointment.meta.tag:Source.display | |
Control | 1..? |
Must Support | true |
13. Appointment.meta.tag:Provenance | |
SliceName | Provenance |
Control | 0..1 |
Must Support | true |
14. Appointment.meta.tag:Provenance.system | |
Control | 1..? |
Fixed Value | https://yhcr.nhs.uk/Provenance |
15. Appointment.meta.tag:Provenance.code | |
Control | 1..? |
Must Support | true |
16. Appointment.meta.tag:Provenance.display | |
Control | 1..? |
Must Support | true |
17. Appointment.implicitRules | |
18. Appointment.language | |
19. Appointment.text | |
20. Appointment.extension:deliveryChannel | |
SliceName | deliveryChannel |
Must Support | true |
21. Appointment.extension:appointmentCancellationReason | |
SliceName | appointmentCancellationReason |
Control | 0..01 |
22. Appointment.extension:bookingOrganisation | |
SliceName | bookingOrganisation |
23. Appointment.extension:appointmentCancellationReasonR4 | |
SliceName | appointmentCancellationReasonR4 |
Control | 0..1 |
Type | Extension(ExtensionInterweaveR4AppointmentCancellationReason) (Extension Type: CodeableConcept) |
Must Support | true |
24. Appointment.extension:patientInstruction | |
SliceName | patientInstruction |
Control | 0..1 |
Type | Extension(ExtensionInterweavePatientInstruction) (Extension Type: string) |
25. Appointment.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Slicing | This element introduces a set of slices on Appointment.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
26. Appointment.identifier:localIdentifier | |
SliceName | localIdentifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Must Support | true |
27. Appointment.identifier:localIdentifier.system | |
Control | 1..? |
Must Support | true |
Fixed Value | https://fhir.yhcr.nhs.uk/Id/local-appointment-identifier |
28. Appointment.identifier:localIdentifier.value | |
Control | 1..? |
Must Support | true |
29. Appointment.identifier:localIdentifier.period | |
Control | 0..0 |
30. Appointment.status | |
Must Support | true |
31. Appointment.serviceCategory | |
32. Appointment.serviceType | |
Control | 10..* |
Binding | The codes SHOULD be taken from Interweave UkCore Care Setting TypeFor example codes, see ServiceType |
Must Support | true |
33. Appointment.serviceType.coding | |
Control | 0..? |
34. Appointment.serviceType.coding.system | |
Control | 1..? |
35. Appointment.serviceType.coding.code | |
Control | 1..? |
36. Appointment.serviceType.coding.display | |
Control | 1..? |
37. Appointment.specialty | |
Binding | The codes SHOULD be taken from Care Connect SDS Job Role NameThe codes SHOULD be taken from Practice Setting Code Value Set |
38. Appointment.specialty.coding | |
Control | 0..? |
39. Appointment.specialty.coding.system | |
Control | 1..? |
40. Appointment.specialty.coding.code | |
Control | 1..? |
41. Appointment.specialty.coding.display | |
Control | 1..? |
42. Appointment.appointmentType | |
Binding | The codes SHALL be taken from InterweaveAppointmentTypeThe codes SHOULD be taken from v2 Appointment reason codes |
Must Support | true |
43. Appointment.appointmentType.coding | |
Control | 0..? |
44. Appointment.appointmentType.coding.system | |
Control | 1..? |
45. Appointment.appointmentType.coding.code | |
Control | 1..? |
46. Appointment.appointmentType.coding.display | |
Control | 1..? |
47. Appointment.reason | |
Binding | The codes SHOULD be taken from Interweave R4 Encounter ReasonThe codes SHOULD be taken from Encounter Reason Codes |
Must Support | true |
48. Appointment.reason.coding | |
Control | 0..? |
49. Appointment.reason.coding.system | |
Control | 1..? |
50. Appointment.reason.coding.code | |
Control | 1..? |
51. Appointment.reason.coding.display | |
Control | 1..? |
52. Appointment.priority | |
53. Appointment.description | |
Must Support | true |
54. Appointment.supportingInformation | |
55. Appointment.start | |
Must Support | true |
56. Appointment.slot | |
57. Appointment.comment | |
58. Appointment.incomingReferral | |
Control | 0..? |
59. Appointment.incomingReferral.reference | |
Control | 1..? |
60. Appointment.incomingReferral.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..? |
61. Appointment.incomingReferral.display | |
Control | 0..? |
62. Appointment.participant | |
Must Support | true |
Slicing | This element introduces a set of slices on Appointment.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
63. Appointment.participant.type | |
Control | 10..1* |
Binding | The codes SHALL be taken from InterweaveAppointmentParticipantTypeThe codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable |
Must Support | true |
64. Appointment.participant.type.coding | |
Control | 0..? |
65. Appointment.participant.type.coding.system | |
Control | 1..? |
66. Appointment.participant.type.coding.code | |
Control | 1..? |
67. Appointment.participant.type.coding.display | |
Control | 1..? |
68. Appointment.participant.actor | |
Control | 10..1 |
Must Support | true |
69. Appointment.participant.status | |
Must Support | true |
70. Appointment.participant:subject | |
SliceName | subject |
Control | 1..1 |
Must Support | true |
71. Appointment.participant:subject.type | |
Control | 0..? |
72. Appointment.participant:subject.type.coding | |
Control | 0..? |
73. Appointment.participant:subject.type.coding.system | |
Control | 0..? |
Fixed Value | http://hl7.org/fhir/v3/ParticipationType |
74. Appointment.participant:subject.type.coding.code | |
Control | 0..? |
Fixed Value | SBJ |
75. Appointment.participant:subject.type.coding.display | |
Control | 0..? |
Fixed Value | subject |
76. Appointment.participant:subject.actor | |
Control | 0..? |
Type | Reference(Patient) |
77. Appointment.participant:subject.actor.reference | |
Control | 1..? |
78. Appointment.participant:subject.actor.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..? |
79. Appointment.participant:subject.actor.display | |
Control | 1..? |
80. Appointment.participant:location | |
SliceName | location |
Control | 0..1 |
Must Support | true |
81. Appointment.participant:location.type | |
Control | 0..? |
82. Appointment.participant:location.type.coding | |
Control | 0..? |
83. Appointment.participant:location.type.coding.system | |
Control | 0..? |
Fixed Value | http://hl7.org/fhir/v3/ParticipationType |
84. Appointment.participant:location.type.coding.code | |
Control | 0..? |
Fixed Value | LOC |
85. Appointment.participant:location.type.coding.display | |
Control | 0..? |
Fixed Value | location |
86. Appointment.participant:location.actor | |
Control | 0..? |
Type | Reference(Location) |
87. Appointment.participant:location.actor.reference | |
Control | 1..? |
88. Appointment.participant:location.actor.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..? |
89. Appointment.participant:location.actor.display | |
Control | 1..? |
90. Appointment.participant:primaryPerformer | |
SliceName | primaryPerformer |
Control | 0..1 |
Must Support | true |
91. Appointment.participant:primaryPerformer.type | |
Control | 0..? |
92. Appointment.participant:primaryPerformer.type.coding | |
Control | 0..? |
93. Appointment.participant:primaryPerformer.type.coding.system | |
Control | 0..? |
Fixed Value | http://hl7.org/fhir/v3/ParticipationType |
94. Appointment.participant:primaryPerformer.type.coding.code | |
Control | 0..? |
Fixed Value | PPRF |
95. Appointment.participant:primaryPerformer.type.coding.display | |
Control | 0..? |
Fixed Value | primary performer |
96. Appointment.participant:primaryPerformer.actor | |
Control | 0..? |
Type | Reference(Practitioner) |
97. Appointment.participant:primaryPerformer.actor.reference | |
Control | 1..? |
98. Appointment.participant:primaryPerformer.actor.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..? |
99. Appointment.participant:primaryPerformer.actor.display | |
Control | 1..? |
100. Appointment.requestedPeriod |
Guidance on how to interpret the contents of this table can be found here.
1. Appointment | |||||
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). | ||||
Control | 0..* | ||||
Invariants | Defined on this element app-2: Either start and end are specified, or neither (: start.empty() xor end.exists()) app-3: Only proposed or cancelled appointments can be missing start/end dates (: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled'))) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) | ||||
2. Appointment.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. Appointment.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
4. Appointment.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
5. Appointment.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||||
6. Appointment.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Control | 0..* | ||||
Type | uri | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
7. Appointment.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Type | Coding | ||||
Summary | true | ||||
Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
8. Appointment.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Slicing | This element introduces a set of slices on Appointment.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
9. Appointment.meta.tag:Source | |||||
SliceName | Source | ||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..1* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
10. Appointment.meta.tag:Source.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 10..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | https://yhcr.nhs.uk/Source | ||||
11. Appointment.meta.tag:Source.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 10..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
12. Appointment.meta.tag:Source.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 10..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
13. Appointment.meta.tag:Provenance | |||||
SliceName | Provenance | ||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..1* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
14. Appointment.meta.tag:Provenance.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 10..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | https://yhcr.nhs.uk/Provenance | ||||
15. Appointment.meta.tag:Provenance.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 10..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
16. Appointment.meta.tag:Provenance.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 10..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
17. Appointment.implicitRules | |||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
18. Appointment.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language.
| ||||
Type | code | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
19. Appointment.text | |||||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
20. Appointment.extension:deliveryChannel | |||||
SliceName | deliveryChannel | ||||
Definition | An extension to record the delivery channel of a scheduled Appointment. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-DeliveryChannel-1) (Extension Type: code) | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
21. Appointment.extension:appointmentCancellationReason | |||||
SliceName | appointmentCancellationReason | ||||
Definition | The reason the appointment was cancelled. | ||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-AppointmentCancellationReason-1) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
22. Appointment.extension:bookingOrganisation | |||||
SliceName | bookingOrganisation | ||||
Definition | An extension to record the organisation booking the appointment. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-BookingOrganisation-1) (Extension Type: Reference) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
23. Appointment.extension:appointmentCancellationReasonR4 | |||||
SliceName | appointmentCancellationReasonR4 | ||||
Definition | The coded reason for the appointment being cancelled. This is pre-adopting a field that is missing in STU3 but added in R4. (And replacing a CareConnect extension which caters for free-text only). | ||||
Control | 0..1 | ||||
Type | Extension(ExtensionInterweaveR4AppointmentCancellationReason) (Extension Type: CodeableConcept) | ||||
Must Support | true | ||||
24. Appointment.extension:patientInstruction | |||||
SliceName | patientInstruction | ||||
Definition | Detailed information and instructions for the patient. Pre-adopted from R4 | ||||
Control | 0..1 | ||||
Type | Extension(ExtensionInterweavePatientInstruction) (Extension Type: string) | ||||
25. Appointment.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
26. Appointment.identifier | |||||
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). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Slicing | This element introduces a set of slices on Appointment.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
27. Appointment.identifier:localIdentifier | |||||
SliceName | localIdentifier | ||||
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). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1* | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
28. Appointment.identifier:localIdentifier.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known . | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
29. Appointment.identifier:localIdentifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 10..1 | ||||
Type | uri | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | https://fhir.yhcr.nhs.uk/Id/local-appointment-identifier | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
30. Appointment.identifier:localIdentifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 10..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
Example | General:123456 | ||||
31. Appointment.identifier:localIdentifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..01 | ||||
Type | Period | ||||
Summary | true | ||||
32. Appointment.status | |||||
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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from AppointmentStatus The free/busy status of an appointment. | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | 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. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. | ||||
33. Appointment.serviceCategory | |||||
Definition | A broad categorisation of the service that is to be performed during this appointment. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Care Connect SDS Job Role Name; other codes may be used where these codes are not suitableFor example codes, see ServiceCategory A ValueSet that contains a set of codes that identify the Practitioner of a scheduled Appointment | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
34. Appointment.serviceType | |||||
Definition | The specific service that is to be performed during this appointment. | ||||
Control | 10..* | ||||
Binding | The codes SHOULD be taken from Interweave UkCore Care Setting TypeFor example codes, see ServiceType | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
35. Appointment.specialty | |||||
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from Care Connect SDS Job Role NameThe codes SHOULD be taken from Practice Setting Code Value Set | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
36. Appointment.appointmentType | |||||
Definition | The style of appointment or patient that has been booked in the slot (not service type). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from InterweaveAppointmentTypeThe codes SHOULD be taken from v2 Appointment reason codes | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
37. Appointment.reason | |||||
Definition | The reason that this appointment is being scheduled. This is more clinical than administrative. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from Interweave R4 Encounter ReasonThe codes SHOULD be taken from Encounter Reason Codes | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
38. Appointment.priority | |||||
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). | ||||
Control | 0..1 | ||||
Type | unsignedInt | ||||
Comments | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a codeableconcept for named values may be tested at a future connectathon. | ||||
39. Appointment.description | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Must Support | true | ||||
40. Appointment.supportingInformation | |||||
Definition | Additional information to support the appointment provided when making the appointment. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
41. Appointment.start | |||||
Definition | Date/Time that the appointment is to take place. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Summary | true | ||||
42. Appointment.slot | |||||
Definition | The slots from the participants' schedules that will be filled by the appointment. | ||||
Control | 0..* | ||||
Type | Reference(Slot) | ||||
43. Appointment.comment | |||||
Definition | Additional comments about the appointment. | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where 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. | ||||
44. Appointment.participant | |||||
Definition | List of participants involved in the appointment. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Appointment.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
45. Appointment.participant.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
46. Appointment.participant.type | |||||
Definition | Role of participant in the appointment. | ||||
Control | 10..1* | ||||
Binding | The codes SHALL be taken from InterweaveAppointmentParticipantTypeThe codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. | ||||
47. Appointment.participant.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 10..1 | ||||
Type | Reference(Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
48. Appointment.participant.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment. | ||||
Type | code | ||||
Must Support | true | ||||
49. Appointment.participant:subject | |||||
SliceName | subject | ||||
Definition | List of participants involved in the appointment. | ||||
Control | 1..1* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
50. Appointment.participant:subject.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
51. Appointment.participant:subject.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location) | ||||
Summary | true | ||||
52. Appointment.participant:subject.actor.reference | |||||
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. | ||||
Control | 10..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
53. Appointment.participant:subject.actor.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
54. Appointment.participant:subject.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 10..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
55. Appointment.participant:subject.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment. | ||||
Type | code | ||||
56. Appointment.participant:location | |||||
SliceName | location | ||||
Definition | List of participants involved in the appointment. | ||||
Control | 01..1* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
57. Appointment.participant:location.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
58. Appointment.participant:location.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(Location|Patient|Practitioner|RelatedPerson|Device|HealthcareService) | ||||
Summary | true | ||||
59. Appointment.participant:location.actor.reference | |||||
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. | ||||
Control | 10..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
60. Appointment.participant:location.actor.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
61. Appointment.participant:location.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 10..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
62. Appointment.participant:location.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment. | ||||
Type | code | ||||
63. Appointment.participant:primaryPerformer | |||||
SliceName | primaryPerformer | ||||
Definition | List of participants involved in the appointment. | ||||
Control | 01..1* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
64. Appointment.participant:primaryPerformer.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
65. Appointment.participant:primaryPerformer.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner|Patient|RelatedPerson|Device|HealthcareService|Location) | ||||
Summary | true | ||||
66. Appointment.participant:primaryPerformer.actor.reference | |||||
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. | ||||
Control | 10..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
67. Appointment.participant:primaryPerformer.actor.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
68. Appointment.participant:primaryPerformer.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 10..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
69. Appointment.participant:primaryPerformer.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment. | ||||
Type | code | ||||
70. Appointment.requestedPeriod | |||||
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. | ||||
Control | 0..* | ||||
Type | Period | ||||
Comments | This does not introduce a capacity for recurring appointments. |
Guidance on how to interpret the contents of this table can be found here.
1. Appointment | |||||
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). | ||||
Control | 0..* | ||||
2. Appointment.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. Appointment.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Summary | true | ||||
4. Appointment.meta.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
5. Appointment.meta.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
6. Appointment.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted. | ||||
Control | 0..1 | ||||
Type | id | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
7. Appointment.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. | ||||
8. Appointment.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Control | 0..* | ||||
Type | uri | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
9. Appointment.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System | ||||
Type | Coding | ||||
Summary | true | ||||
Comments | The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
10. Appointment.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..* | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones | ||||
Type | Coding | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Slicing | This element introduces a set of slices on Appointment.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
11. Appointment.meta.tag:Source | |||||
SliceName | Source | ||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
12. Appointment.meta.tag:Source.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
13. Appointment.meta.tag:Source.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
14. Appointment.meta.tag:Source.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | https://yhcr.nhs.uk/Source | ||||
15. Appointment.meta.tag:Source.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
16. Appointment.meta.tag:Source.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
17. Appointment.meta.tag:Source.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
18. Appointment.meta.tag:Source.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
19. Appointment.meta.tag:Provenance | |||||
SliceName | Provenance | ||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..1 | ||||
Binding | For example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones | ||||
Type | Coding | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
20. Appointment.meta.tag:Provenance.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
21. Appointment.meta.tag:Provenance.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
22. Appointment.meta.tag:Provenance.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | https://yhcr.nhs.uk/Provenance | ||||
23. Appointment.meta.tag:Provenance.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
24. Appointment.meta.tag:Provenance.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
25. Appointment.meta.tag:Provenance.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
26. Appointment.meta.tag:Provenance.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
27. Appointment.implicitRules | |||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Summary | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
28. Appointment.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
A human language
| ||||
Type | code | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
29. Appointment.text | |||||
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
Type | Narrative | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
30. Appointment.contained | |||||
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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. | ||||
31. Appointment.extension | |||||
Definition | An Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on Appointment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
32. Appointment.extension:deliveryChannel | |||||
SliceName | deliveryChannel | ||||
Definition | An extension to record the delivery channel of a scheduled Appointment. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-DeliveryChannel-1) (Extension Type: code) | ||||
Must Support | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
33. Appointment.extension:appointmentCancellationReason | |||||
SliceName | appointmentCancellationReason | ||||
Definition | The reason the appointment was cancelled. | ||||
Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-AppointmentCancellationReason-1) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
34. Appointment.extension:bookingOrganisation | |||||
SliceName | bookingOrganisation | ||||
Definition | An extension to record the organisation booking the appointment. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(Extension-CareConnect-BookingOrganisation-1) (Extension Type: Reference) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
35. Appointment.extension:appointmentCancellationReasonR4 | |||||
SliceName | appointmentCancellationReasonR4 | ||||
Definition | The coded reason for the appointment being cancelled. This is pre-adopting a field that is missing in STU3 but added in R4. (And replacing a CareConnect extension which caters for free-text only). | ||||
Control | 0..1 | ||||
Type | Extension(ExtensionInterweaveR4AppointmentCancellationReason) (Extension Type: CodeableConcept) | ||||
Must Support | true | ||||
36. Appointment.extension:patientInstruction | |||||
SliceName | patientInstruction | ||||
Definition | Detailed information and instructions for the patient. Pre-adopted from R4 | ||||
Control | 0..1 | ||||
Type | Extension(ExtensionInterweavePatientInstruction) (Extension Type: string) | ||||
37. Appointment.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
38. Appointment.identifier | |||||
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). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Summary | true | ||||
Slicing | This element introduces a set of slices on Appointment.identifier. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
39. Appointment.identifier:localIdentifier | |||||
SliceName | localIdentifier | ||||
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). | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Must Support | true | ||||
Summary | true | ||||
40. Appointment.identifier:localIdentifier.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
41. Appointment.identifier:localIdentifier.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
42. Appointment.identifier:localIdentifier.use | |||||
Definition | The purpose of this identifier. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known | ||||
Type | code | ||||
Is Modifier | true | ||||
Summary | true | ||||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
43. Appointment.identifier:localIdentifier.type | |||||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
44. Appointment.identifier:localIdentifier.system | |||||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
Fixed Value | https://fhir.yhcr.nhs.uk/Id/local-appointment-identifier | ||||
Example | General:http://www.acme.com/identifiers/patient | ||||
45. Appointment.identifier:localIdentifier.value | |||||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. | ||||
Example | General:123456 | ||||
46. Appointment.identifier:localIdentifier.period | |||||
Definition | Time period during which identifier is/was valid for use. | ||||
Control | 0..0 | ||||
Type | Period | ||||
Summary | true | ||||
47. Appointment.identifier:localIdentifier.assigner | |||||
Definition | Organization that issued/manages the identifier. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | true | ||||
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
48. Appointment.status | |||||
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. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from AppointmentStatus The free/busy status of an appointment | ||||
Type | code | ||||
Is Modifier | true | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | 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. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid. | ||||
49. Appointment.serviceCategory | |||||
Definition | A broad categorisation of the service that is to be performed during this appointment. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Care Connect SDS Job Role Name; other codes may be used where these codes are not suitable A ValueSet that contains a set of codes that identify the Practitioner of a scheduled Appointment | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
50. Appointment.serviceType | |||||
Definition | The specific service that is to be performed during this appointment. | ||||
Control | 1..* | ||||
Binding | The codes SHOULD be taken from Interweave UkCore Care Setting Type | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
51. Appointment.serviceType.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
52. Appointment.serviceType.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.serviceType.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
53. Appointment.serviceType.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
54. Appointment.serviceType.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
55. Appointment.serviceType.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.serviceType.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
56. Appointment.serviceType.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
57. Appointment.serviceType.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
58. Appointment.serviceType.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
59. Appointment.serviceType.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
60. Appointment.serviceType.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
61. Appointment.serviceType.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
62. Appointment.specialty | |||||
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from Care Connect SDS Job Role Name | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
63. Appointment.specialty.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
64. Appointment.specialty.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.specialty.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
65. Appointment.specialty.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
66. Appointment.specialty.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
67. Appointment.specialty.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.specialty.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
68. Appointment.specialty.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
69. Appointment.specialty.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
70. Appointment.specialty.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
71. Appointment.specialty.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
72. Appointment.specialty.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
73. Appointment.specialty.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
74. Appointment.appointmentType | |||||
Definition | The style of appointment or patient that has been booked in the slot (not service type). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from InterweaveAppointmentType | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
75. Appointment.appointmentType.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
76. Appointment.appointmentType.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.appointmentType.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
77. Appointment.appointmentType.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
78. Appointment.appointmentType.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
79. Appointment.appointmentType.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.appointmentType.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
80. Appointment.appointmentType.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
81. Appointment.appointmentType.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
82. Appointment.appointmentType.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
83. Appointment.appointmentType.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
84. Appointment.appointmentType.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
85. Appointment.appointmentType.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
86. Appointment.reason | |||||
Definition | The reason that this appointment is being scheduled. This is more clinical than administrative. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from Interweave R4 Encounter Reason | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
87. Appointment.reason.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
88. Appointment.reason.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.reason.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
89. Appointment.reason.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
90. Appointment.reason.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
91. Appointment.reason.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.reason.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
92. Appointment.reason.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
93. Appointment.reason.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
94. Appointment.reason.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
95. Appointment.reason.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
96. Appointment.reason.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
97. Appointment.reason.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
98. Appointment.indication | |||||
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. | ||||
Control | 0..* | ||||
Type | Reference(Condition|Procedure) | ||||
99. Appointment.priority | |||||
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). | ||||
Control | 0..1 | ||||
Type | unsignedInt | ||||
Comments | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a codeableconcept for named values may be tested at a future connectathon. | ||||
100. Appointment.description | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Must Support | true | ||||
101. Appointment.supportingInformation | |||||
Definition | Additional information to support the appointment provided when making the appointment. | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
102. Appointment.start | |||||
Definition | Date/Time that the appointment is to take place. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Must Support | true | ||||
Summary | true | ||||
103. Appointment.end | |||||
Definition | Date/Time that the appointment is to conclude. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Summary | true | ||||
104. Appointment.minutesDuration | |||||
Definition | Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request). | ||||
Control | 0..1 | ||||
Type | positiveInt | ||||
105. Appointment.slot | |||||
Definition | The slots from the participants' schedules that will be filled by the appointment. | ||||
Control | 0..* | ||||
Type | Reference(Slot) | ||||
106. Appointment.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. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Comments | 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. | ||||
107. Appointment.comment | |||||
Definition | Additional comments about the appointment. | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where 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. | ||||
108. Appointment.incomingReferral | |||||
Definition | The referral request this appointment is allocated to assess (incoming referral). | ||||
Control | 0..* | ||||
Type | Reference(ReferralRequest) | ||||
109. Appointment.incomingReferral.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
110. Appointment.incomingReferral.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.incomingReferral.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
111. Appointment.incomingReferral.reference | |||||
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. | ||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
112. Appointment.incomingReferral.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
113. Appointment.incomingReferral.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
114. Appointment.participant | |||||
Definition | List of participants involved in the appointment. | ||||
Control | 1..* | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on Appointment.participant. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
115. Appointment.participant.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
116. Appointment.participant.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
117. Appointment.participant.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
118. Appointment.participant.type | |||||
Definition | Role of participant in the appointment. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from InterweaveAppointmentParticipantType | ||||
Type | CodeableConcept | ||||
Must Support | true | ||||
Summary | true | ||||
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. | ||||
119. Appointment.participant.type.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
120. Appointment.participant.type.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
121. Appointment.participant.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
122. Appointment.participant.type.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
123. Appointment.participant.type.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
124. Appointment.participant.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
125. Appointment.participant.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
126. Appointment.participant.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 1..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
127. Appointment.participant.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
128. Appointment.participant.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
129. Appointment.participant.type.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
130. Appointment.participant.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 1..1 | ||||
Type | Reference(Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location) | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
131. Appointment.participant.required | |||||
Definition | Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment | ||||
Type | code | ||||
Summary | true | ||||
132. Appointment.participant.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment | ||||
Type | code | ||||
Must Support | true | ||||
133. Appointment.participant:subject | |||||
SliceName | subject | ||||
Definition | List of participants involved in the appointment. | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
134. Appointment.participant:subject.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
135. Appointment.participant:subject.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
136. Appointment.participant:subject.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
137. Appointment.participant:subject.type | |||||
Definition | Role of participant in the appointment. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. | ||||
138. Appointment.participant:subject.type.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
139. Appointment.participant:subject.type.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
140. Appointment.participant:subject.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
141. Appointment.participant:subject.type.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
142. Appointment.participant:subject.type.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
143. Appointment.participant:subject.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | http://hl7.org/fhir/v3/ParticipationType | ||||
144. Appointment.participant:subject.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
145. Appointment.participant:subject.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | SBJ | ||||
146. Appointment.participant:subject.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Fixed Value | subject | ||||
147. Appointment.participant:subject.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
148. Appointment.participant:subject.type.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
149. Appointment.participant:subject.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(Patient) | ||||
Summary | true | ||||
150. Appointment.participant:subject.actor.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
151. Appointment.participant:subject.actor.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
152. Appointment.participant:subject.actor.reference | |||||
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. | ||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
153. Appointment.participant:subject.actor.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
154. Appointment.participant:subject.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
155. Appointment.participant:subject.required | |||||
Definition | Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment | ||||
Type | code | ||||
Summary | true | ||||
156. Appointment.participant:subject.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment | ||||
Type | code | ||||
157. Appointment.participant:location | |||||
SliceName | location | ||||
Definition | List of participants involved in the appointment. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
158. Appointment.participant:location.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
159. Appointment.participant:location.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
160. Appointment.participant:location.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
161. Appointment.participant:location.type | |||||
Definition | Role of participant in the appointment. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. | ||||
162. Appointment.participant:location.type.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
163. Appointment.participant:location.type.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
164. Appointment.participant:location.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
165. Appointment.participant:location.type.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
166. Appointment.participant:location.type.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
167. Appointment.participant:location.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | http://hl7.org/fhir/v3/ParticipationType | ||||
168. Appointment.participant:location.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
169. Appointment.participant:location.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | LOC | ||||
170. Appointment.participant:location.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Fixed Value | location | ||||
171. Appointment.participant:location.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
172. Appointment.participant:location.type.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
173. Appointment.participant:location.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(Location) | ||||
Summary | true | ||||
174. Appointment.participant:location.actor.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
175. Appointment.participant:location.actor.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
176. Appointment.participant:location.actor.reference | |||||
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. | ||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
177. Appointment.participant:location.actor.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
178. Appointment.participant:location.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
179. Appointment.participant:location.required | |||||
Definition | Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment | ||||
Type | code | ||||
Summary | true | ||||
180. Appointment.participant:location.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment | ||||
Type | code | ||||
181. Appointment.participant:primaryPerformer | |||||
SliceName | primaryPerformer | ||||
Definition | List of participants involved in the appointment. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Must Support | true | ||||
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) | ||||
182. Appointment.participant:primaryPerformer.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
183. Appointment.participant:primaryPerformer.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
184. Appointment.participant:primaryPerformer.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Summary | true | ||||
Alternate Names | extensions, user content, modifiers | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
185. Appointment.participant:primaryPerformer.type | |||||
Definition | Role of participant in the appointment. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment. | ||||
186. Appointment.participant:primaryPerformer.type.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
187. Appointment.participant:primaryPerformer.type.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
188. Appointment.participant:primaryPerformer.type.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Summary | true | ||||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
Comments | 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. | ||||
189. Appointment.participant:primaryPerformer.type.coding.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
190. Appointment.participant:primaryPerformer.type.coding.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.type.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
191. Appointment.participant:primaryPerformer.type.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. | ||||
Fixed Value | http://hl7.org/fhir/v3/ParticipationType | ||||
192. Appointment.participant:primaryPerformer.type.coding.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
193. Appointment.participant:primaryPerformer.type.coding.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Type | code | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Fixed Value | PPRF | ||||
194. Appointment.participant:primaryPerformer.type.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Fixed Value | primary performer | ||||
195. Appointment.participant:primaryPerformer.type.coding.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
196. Appointment.participant:primaryPerformer.type.text | |||||
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. | ||||
Control | 0..1 | ||||
Type | string | ||||
Summary | true | ||||
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. | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
197. Appointment.participant:primaryPerformer.actor | |||||
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner) | ||||
Summary | true | ||||
198. Appointment.participant:primaryPerformer.actor.id | |||||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
199. Appointment.participant:primaryPerformer.actor.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensions, user content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Slicing | This element introduces a set of slices on Appointment.participant.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
200. Appointment.participant:primaryPerformer.actor.reference | |||||
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. | ||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
201. Appointment.participant:primaryPerformer.actor.identifier | |||||
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
Comments | 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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
202. Appointment.participant:primaryPerformer.actor.display | |||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
Control | 1..1 | ||||
Type | string | ||||
Summary | true | ||||
Comments | 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. | ||||
203. Appointment.participant:primaryPerformer.required | |||||
Definition | Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment | ||||
Type | code | ||||
Summary | true | ||||
204. Appointment.participant:primaryPerformer.status | |||||
Definition | Participation status of the actor. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment | ||||
Type | code | ||||
205. Appointment.requestedPeriod | |||||
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. | ||||
Control | 0..* | ||||
Type | Period | ||||
Comments | This does not introduce a capacity for recurring appointments. |