Appointment

There are no (further) constraints on this element

Element id

Appointment

Short description

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)

Definition

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
app-3: Only proposed or cancelled appointments can be missing start/end dates
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-2: Either start and end are specified, or neither
start.exists() = end.exists()

Mappings

rim: Entity. Role, or Act
workflow: Request
rim: Act[@moodCode <= 'INT']
ical: VEVENT

0..1

There are no (further) constraints on this element

Element id

Appointment.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Element id

Appointment.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

versionId

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

lastUpdated

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

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. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

source

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

profile

O Σ

0..*

Element id

Appointment.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

security

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Appointment.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

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.

Data type

AllSecurityLabels (extensible)

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

tag

0..*

There are no (further) constraints on this element

Element id

Appointment.meta.tag

Short description

Tags applied to this resource

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.

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.

Data type

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Appointment.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

MaxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Element id

Appointment.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

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 information is added later.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

0..1

There are no (further) constraints on this element

Element id

Appointment.text.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

status

1..1

codeBinding

Element id

Appointment.text.status

Short description

generated | extensions | additional | empty

Definition

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Binding

The status of a resource narrative.

NarrativeStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

div

O C

1..1

Element id

Appointment.text.div

Short description

Limited xhtml content

Definition

The actual narrative content, a stripped down version of XHTML.

Comments

The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
htmlChecks()
txt-2: The narrative SHALL have some non-whitespace content
htmlChecks()

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

contained

0..*

There are no (further) constraints on this element

Element id

Appointment.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

class

O C

0..1

Element id

Appointment.extension:class

Short description

Classification when becoming an encounter

Alternate names

extensions, user content

Definition

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

Comments

Data type

ExtensionAppointment_Class

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:class.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension:class.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Appointment.extension:class.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

Fixed value

http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class

Mappings

rim: N/A

value[x]

0..1

Binding

Element id

Appointment.extension:class.value[x]

Short description

Classification when becoming an encounter

Definition

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

Binding

EncounterClass (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

valueCodeableConcept

There are no (further) constraints on this element

Data type

AppointmentVirtualService

AppointmentVirtualService

0..0

Extension(Complex)

Element id

Appointment.extension:AppointmentVirtualService

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

To represent the Appointment R5 virtual service element which is of the new type VirtualServiceDetail.

Comments

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

VirtualService

O C

0..*

Extension(Complex)

Element id

Appointment.extension:VirtualService

Short description

R5: Connection details of a virtual service (e.g. conference call) (new)

Alternate names

extensions, user content

Definition

R5: Appointment.virtualService (new:VirtualServiceDetail)

Comments

Element Appointment.virtualService has a context of Appointment based on following the parent source element upwards and mapping to Appointment. Element Appointment.virtualService has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). There are two types of virtual meetings that often exist:

a persistent, virtual meeting room that can only be used for a single purpose at a time,
and a dynamic virtual meeting room that is generated on demand for a specific purpose.

Implementers may consider using Location.virtualService for persistent meeting rooms.

If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Appointment.participant BackboneElement.

Data type

Extension(Complex)

Extension URL

ExtensionAppointment_VirtualService

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Appointment.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

O Σ

1..*

Element id

Appointment.identifier

Short description

External Ids for this item

Definition

This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
w5: FiveWs.identifier
v2: SCH-1, SCH-2, ARQ-1, ARQ-2
rim: .id
ical: UID

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

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.

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

O Σ

0..1

Element id

Appointment.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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.

Comments

Identifier.system is always case sensitive.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

value

O Σ

0..1

Element id

Appointment.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

status

SO Σ ?!

1..1

codeBinding

Element id

Appointment.status

Short description

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.

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.

Data type

Binding

The free/busy status of an appointment.

AppointmentStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status
w5: FiveWs.status
v2: SCH-25
rim: .statusCode
ical: STATUS

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

cancelationReason

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason

Short description

The coded reason for the appointment being cancelled

Definition

The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

AppointmentCancellationReason (example)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

serviceCategory

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceCategory

Short description

A broad categorization of the service that is to be performed during this appointment

Definition

A broad categorization of the service that is to be performed during this appointment.

Comments

Data type

Binding

ServiceCategory (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: n/a, might be inferred from the ServiceDeliveryLocation
ical: CATEGORIES

serviceType

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceType

Short description

The specific service that is to be performed during this appointment

Definition

The specific service that is to be performed during this appointment.

Comments

For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

Data type

Binding

ServiceType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
rim: n/a, might be inferred from the ServiceDeliveryLocation

specialty

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.specialty

Short description

The specialty of a practitioner that would be required to perform the service requested in this appointment

Definition

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Comments

Data type

PracticeSettingCodeValueSet (preferred)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .performer.AssignedPerson.code

appointmentType

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.appointmentType

Short description

The style of appointment or patient that has been booked in the slot (not service type)

Definition

The style of appointment or patient that has been booked in the slot (not service type).

Comments

Data type

Hl7VSAppointmentReasonCodes (preferred)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: ARQ-7
rim: .code
ical: CLASSIFICATION

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

O Σ

0..1

Element id

Appointment.appointmentType.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

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 reference to some definition that establishes the system clearly and unambiguously.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

version

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.version

Short description

Version of the system - if relevant

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.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

O Σ

0..1

Element id

Appointment.appointmentType.coding.code

Short description

Symbol in syntax defined by the system

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).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

display

O Σ

0..1

Element id

Appointment.appointmentType.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

userSelected

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

O Σ

0..1

Element id

Appointment.appointmentType.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

reasonCode

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.reasonCode

Short description

Coded reason this appointment is scheduled

Definition

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

Comments

Data type

EncounterReasonCodes (preferred)

Binding

The Reason for the appointment to take place.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode
v2: AIS-3, SCH-7
rim: .reasonCode

reasonReference

0..*

Reference(ConditionCACore | ProcedureCACore | ImmunizationRecommendation | Observation)

There are no (further) constraints on this element

Element id

Appointment.reasonReference

Short description

Reason the appointment is to take place (resource)

Definition

Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(ConditionCACore | ProcedureCACore | ImmunizationRecommendation | Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
rim: .inboundRelationship[@typeCode = 'RSON'].observation

priority

0..1

There are no (further) constraints on this element

Element id

Appointment.priority

Short description

Used to make informed decisions if needing to re-prioritize

Definition

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.priority
w5: FiveWs.class
v2: ARQ-12, SCH-11.6 / TQ1-9
rim: .priorityCode
ical: PRIORITY

description

0..1

Element id

Appointment.description

Short description

Shown on a subject line in a meeting request, or appointment list

Definition

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: NTE-3
rim: .text
ical: SUMMARY

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

supportingInformation

0..*

There are no (further) constraints on this element

Element id

Appointment.supportingInformation

Short description

Additional information to support the appointment

Definition

Additional information to support the appointment provided when making the appointment.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.supportingInfo
w5: FiveWs.context
rim: .inboundRelationship[@typeCode = 'SPRT'].observation
ical: ATTACH

start

SO Σ

0..1

Element id

Appointment.start

Short description

When appointment is to take place

Definition

Date/Time that the appointment is to take place.

Comments

Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]
w5: FiveWs.init
v2: ARQ-11.1, SCH-11.4 / TQ1-7
rim: .effectiveTime.low
ical: DTSTART

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

end

0..1

There are no (further) constraints on this element

Element id

Appointment.end

Short description

When appointment is to conclude

Definition

Date/Time that the appointment is to conclude.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]
w5: FiveWs.done[x]
v2: SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
rim: .effectiveTime.high
ical: DTEND

minutesDuration

0..1

There are no (further) constraints on this element

Element id

Appointment.minutesDuration

Short description

Can be less than start/end (e.g. estimate)

Definition

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

Comments

32 bit number; for values larger than this, use decimal

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]
rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
ical: DURATION (e.g. PT15M)

slot

0..*

There are no (further) constraints on this element

Element id

Appointment.slot

Short description

The slots that this appointment is filling

Definition

The slots from the participants' schedules that will be filled by the appointment.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']

created

0..1

Element id

Appointment.created

Short description

The date that this appointment was initially created

Definition

The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.authoredOn
rim: .author.time
ical: CREATED

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

comment

0..1

Element id

Appointment.comment

Short description

Additional comments

Definition

Additional comments about the appointment.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.note
v2: NTE-3
rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
ical: DESCRIPTION (for internal use)

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

patientInstruction

0..1

Element id

Appointment.patientInstruction

Short description

Detailed information and instructions for the patient

Definition

While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: NTE-3
rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
ical: DESCRIPTION (for patient use)

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

basedOn

SO C

1..1

Element id

Appointment.basedOn

Short description

The service request this appointment is allocated to assess

Alternate names

incomingReferral

Definition

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn
rim: .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.basedOn.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

SO Σ C

0..1

Element id

Appointment.basedOn.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Appointment.basedOn.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

SO Σ

0..1

Element id

Appointment.basedOn.identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

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.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

O Σ ?!

1..1

codeBinding

Element id

Appointment.basedOn.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

SO Σ

1..1

Element id

Appointment.basedOn.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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.

Comments

Identifier.system is always case sensitive.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

value

SO Σ

1..1

Element id

Appointment.basedOn.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

participant

O C

1..*

Element id

Appointment.participant

Short description

Participants involved in appointment

Definition

List of participants involved in the appointment.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
app-1: Either the type or actor on the participant SHALL be specified
type.exists() or actor.exists()

Mappings

rim: n/a
workflow: Request.performer, Request.subject
v2: PID, AIP, AIG, AIL
rim: performer | reusableDevice | subject | location
ical: ATTENDEE component to be created

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

type

SO Σ

0..*

CodeableConceptBinding

Element id

Appointment.participant.type

Short description

Role of participant in the appointment

Definition

Role of participant in the appointment.

Comments

The role of the participant can be used to declare what the actor will be doing in the scope of 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.

Data type

Binding

Role of participant in encounter.

ParticipantType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: AIP-4, AIG-4
rim: (performer | reusableDevice | subject | location).@typeCode
ical: n/a

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

actor

O Σ C

0..1

Reference(PCareLocation | PCarePatient | PCarePractitionerRole)

Element id

Appointment.participant.actor

Short description

Person, Location/HealthcareService or Device

Definition

A Person, Location/HealthcareService or Device that is participating in the appointment.

Comments

Data type

Reference(PCareLocation | PCarePatient | PCarePractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.who
v2: PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
rim: performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
ical: ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
CACDI: Patient
CACDI: Health Care Provider

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.actor.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

O Σ C

0..1

Element id

Appointment.participant.actor.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Appointment.participant.actor.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

SO Σ

0..1

Element id

Appointment.participant.actor.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

SO Σ

1..1

Element id

Appointment.participant.actor.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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.

Comments

Identifier.system is always case sensitive.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
	SHALL:no-error		http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer

value

O Σ

1..1

Element id

Appointment.participant.actor.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

required

O Σ

0..1

codeBinding

Element id

Appointment.participant.required

Short description

required | optional | information-only

Definition

Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ParticipantRequired (required)

Binding

Is the Participant required to attend the appointment.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: (performer | reusableDevice | subject | location).@performInd
ical: ROLE=REQ-PARTICIPANT (roleparam)

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

status

O Σ

1..1

codeBinding

Element id

Appointment.participant.status

Short description

accepted | declined | tentative | needs-action

Definition

Participation status of the actor.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ParticipationStatus (required)

Binding

The Participation status of an appointment.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: AIP-12, AIG-14
rim: (performer | reusableDevice | subject | location).statusCode
ical: ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

period

O C

0..1

Element id

Appointment.participant.period

Short description

Participation period of the actor

Definition

Participation period of the actor.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

start

O Σ C

0..1

Element id

Appointment.participant.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: DR.1
rim: ./low

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

end

O Σ C

0..1

Element id

Appointment.participant.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: DR.2
rim: ./high

Obligations

Name	Code	Documentation	Actor
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server

requestedPeriod

0..*

There are no (further) constraints on this element

Element id

Appointment.requestedPeriod

Short description

Potential date/time interval(s) requested to allocate the appointment within

Definition

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

Comments

This does not introduce a capacity for recurring appointments.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Request.occurrence[x]
v2: ARQ-11
rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]

PCareAppointment (Appointment)

There are no (further) constraints on this element

Element id

Appointment

Short description

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)

Definition

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
app-3: Only proposed or cancelled appointments can be missing start/end dates
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-2: Either start and end are specified, or neither
start.exists() = end.exists()

Mappings

rim: Entity. Role, or Act
workflow: Request
rim: Act[@moodCode <= 'INT']
ical: VEVENT

0..1

There are no (further) constraints on this element

Element id

Appointment.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

There are no (further) constraints on this element

Element id

Appointment.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

versionId

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

lastUpdated

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

source

0..1

There are no (further) constraints on this element

Element id

Appointment.meta.source

Short description

Identifies where the resource comes from

Definition

Comments

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

profile

O Σ

0..*

There are no (further) constraints on this element

Element id

Appointment.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

security

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Appointment.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

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.

Data type

All Security Labels (extensible)

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

tag

0..*

There are no (further) constraints on this element

Element id

Appointment.meta.tag

Short description

Tags applied to this resource

Definition

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.

Data type

Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Appointment.implicitRules

Short description

A set of rules under which this content was created

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

MaxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

Appointment.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

0..1

There are no (further) constraints on this element

Element id

Appointment.text.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.text.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

status

1..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.text.status

Short description

generated | extensions | additional | empty

Definition

The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

Data type

Binding

The status of a resource narrative.

NarrativeStatus (required)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

div

O C

1..1

There are no (further) constraints on this element

Element id

Appointment.text.div

Short description

Limited xhtml content

Definition

The actual narrative content, a stripped down version of XHTML.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
htmlChecks()
txt-2: The narrative SHALL have some non-whitespace content
htmlChecks()

Mappings

rim: N/A

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

contained

0..*

There are no (further) constraints on this element

Element id

Appointment.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

class

O C

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:class

Short description

Classification when becoming an encounter

Definition

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

Comments

Data type

ExtensionAppointment_Class

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

0..1

There are no (further) constraints on this element

Element id

Appointment.extension:class.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.extension:class.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Appointment.extension:class.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

Data type

Fixed value

http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.class

Mappings

rim: N/A

value[x]

0..1

Binding

There are no (further) constraints on this element

Element id

Appointment.extension:class.value[x]

Short description

Classification when becoming an encounter

Definition

Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

Binding

EncounterClass (preferred)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: N/A

valueCodeableConcept

There are no (further) constraints on this element

Data type

AppointmentVirtualService

AppointmentVirtualService

0..0

Extension(Complex)

There are no (further) constraints on this element

Element id

Appointment.extension:AppointmentVirtualService

Short description

Optional Extensions Element

Definition

To represent the Appointment R5 virtual service element which is of the new type VirtualServiceDetail.

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

VirtualService

O C

0..*

Extension(Complex)

There are no (further) constraints on this element

Element id

Appointment.extension:VirtualService

Short description

R5: Connection details of a virtual service (e.g. conference call) (new)

Definition

R5: Appointment.virtualService (new:VirtualServiceDetail)

Comments

a persistent, virtual meeting room that can only be used for a single purpose at a time,
and a dynamic virtual meeting room that is generated on demand for a specific purpose.

Implementers may consider using Location.virtualService for persistent meeting rooms.

If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Appointment.participant BackboneElement.

Data type

Extension(Complex)

Extension URL

ExtensionAppointment_VirtualService

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Appointment.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

O Σ

1..*

There are no (further) constraints on this element

Element id

Appointment.identifier

Short description

External Ids for this item

Definition

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
w5: FiveWs.identifier
v2: SCH-1, SCH-2, ARQ-1, ARQ-2
rim: .id
ical: UID

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.5
rim: Role.code or implied by context

system

O Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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.

Comments

Identifier.system is always case sensitive.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

value

O Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

period

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

0..1

There are no (further) constraints on this element

Element id

Appointment.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

status

SO Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.status

Short description

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.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.

Data type

Binding

The free/busy status of an appointment.

AppointmentStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status
w5: FiveWs.status
v2: SCH-25
rim: .statusCode
ical: STATUS

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

cancelationReason

0..1

There are no (further) constraints on this element

Element id

Appointment.cancelationReason

Short description

The coded reason for the appointment being cancelled

Definition

The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

Comments

Data type

AppointmentCancellationReason (example)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

serviceCategory

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceCategory

Short description

A broad categorization of the service that is to be performed during this appointment

Definition

A broad categorization of the service that is to be performed during this appointment.

Comments

Data type

Binding

ServiceCategory (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: n/a, might be inferred from the ServiceDeliveryLocation
ical: CATEGORIES

serviceType

0..*

There are no (further) constraints on this element

Element id

Appointment.serviceType

Short description

The specific service that is to be performed during this appointment

Definition

The specific service that is to be performed during this appointment.

Comments

For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

Data type

Binding

ServiceType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
rim: n/a, might be inferred from the ServiceDeliveryLocation

specialty

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.specialty

Short description

The specialty of a practitioner that would be required to perform the service requested in this appointment

Definition

The specialty of a practitioner that would be required to perform the service requested in this appointment.

Comments

Data type

PracticeSettingCodeValueSet (preferred)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.class
rim: .performer.AssignedPerson.code

appointmentType

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.appointmentType

Short description

The style of appointment or patient that has been booked in the slot (not service type)

Definition

The style of appointment or patient that has been booked in the slot (not service type).

Comments

Data type

Hl7VSAppointmentReasonCodes (preferred)

Binding

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: ARQ-7
rim: .code
ical: CLASSIFICATION

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

coding

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

system

O Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

version

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

O Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.code

Short description

Symbol in syntax defined by the system

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).

Requirements

Need to refer to a particular code in the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

display

O Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

userSelected

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

O Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.appointmentType.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

reasonCode

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.reasonCode

Short description

Coded reason this appointment is scheduled

Definition

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

Comments

Data type

EncounterReasonCodes (preferred)

Binding

The Reason for the appointment to take place.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode
v2: AIS-3, SCH-7
rim: .reasonCode

reasonReference

0..*

Reference(ConditionCACore | ProcedureCACore | ImmunizationRecommendation | Observation)

There are no (further) constraints on this element

Element id

Appointment.reasonReference

Short description

Reason the appointment is to take place (resource)

Definition

Comments

Data type

Reference(ConditionCACore | ProcedureCACore | ImmunizationRecommendation | Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
rim: .inboundRelationship[@typeCode = 'RSON'].observation

priority

0..1

There are no (further) constraints on this element

Element id

Appointment.priority

Short description

Used to make informed decisions if needing to re-prioritize

Definition

The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.priority
w5: FiveWs.class
v2: ARQ-12, SCH-11.6 / TQ1-9
rim: .priorityCode
ical: PRIORITY

description

0..1

There are no (further) constraints on this element

Element id

Appointment.description

Short description

Shown on a subject line in a meeting request, or appointment list

Definition

The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: NTE-3
rim: .text
ical: SUMMARY

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

supportingInformation

0..*

There are no (further) constraints on this element

Element id

Appointment.supportingInformation

Short description

Additional information to support the appointment

Definition

Additional information to support the appointment provided when making the appointment.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.supportingInfo
w5: FiveWs.context
rim: .inboundRelationship[@typeCode = 'SPRT'].observation
ical: ATTACH

start

SO Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.start

Short description

When appointment is to take place

Definition

Date/Time that the appointment is to take place.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]
w5: FiveWs.init
v2: ARQ-11.1, SCH-11.4 / TQ1-7
rim: .effectiveTime.low
ical: DTSTART

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

end

0..1

There are no (further) constraints on this element

Element id

Appointment.end

Short description

When appointment is to conclude

Definition

Date/Time that the appointment is to conclude.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]
w5: FiveWs.done[x]
v2: SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
rim: .effectiveTime.high
ical: DTEND

minutesDuration

0..1

There are no (further) constraints on this element

Element id

Appointment.minutesDuration

Short description

Can be less than start/end (e.g. estimate)

Definition

Comments

32 bit number; for values larger than this, use decimal

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence[x]
rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
ical: DURATION (e.g. PT15M)

slot

0..*

There are no (further) constraints on this element

Element id

Appointment.slot

Short description

The slots that this appointment is filling

Definition

The slots from the participants' schedules that will be filled by the appointment.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']

created

0..1

There are no (further) constraints on this element

Element id

Appointment.created

Short description

The date that this appointment was initially created

Definition

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.authoredOn
rim: .author.time
ical: CREATED

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

comment

0..1

There are no (further) constraints on this element

Element id

Appointment.comment

Short description

Additional comments

Definition

Additional comments about the appointment.

Comments

Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival"

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.note
v2: NTE-3
rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
ical: DESCRIPTION (for internal use)

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

patientInstruction

0..1

There are no (further) constraints on this element

Element id

Appointment.patientInstruction

Short description

Detailed information and instructions for the patient

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: NTE-3
rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
ical: DESCRIPTION (for patient use)

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

basedOn

SO C

1..1

There are no (further) constraints on this element

Element id

Appointment.basedOn

Short description

The service request this appointment is allocated to assess

Alternate names

incomingReferral

Definition

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn
rim: .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.basedOn.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

SO Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Appointment.basedOn.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

SO Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

O Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

SO Σ

1..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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.

Comments

Identifier.system is always case sensitive.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

value

SO Σ

1..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..1

There are no (further) constraints on this element

Element id

Appointment.basedOn.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

participant

O C

1..*

There are no (further) constraints on this element

Element id

Appointment.participant

Short description

Participants involved in appointment

Definition

List of participants involved in the appointment.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
app-1: Either the type or actor on the participant SHALL be specified
type.exists() or actor.exists()

Mappings

rim: n/a
workflow: Request.performer, Request.subject
v2: PID, AIP, AIG, AIL
rim: performer | reusableDevice | subject | location
ical: ATTENDEE component to be created

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

type

SO Σ

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.participant.type

Short description

Role of participant in the appointment

Definition

Role of participant in the appointment.

Comments

The role of the participant can be used to declare what the actor will be doing in the scope of 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.

Data type

Binding

Role of participant in encounter.

ParticipantType (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: AIP-4, AIG-4
rim: (performer | reusableDevice | subject | location).@typeCode
ical: n/a

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

actor

O Σ C

0..1

Reference(PCareLocation | PCarePatient | PCarePractitionerRole)

There are no (further) constraints on this element

Element id

Appointment.participant.actor

Short description

Person, Location/HealthcareService or Device

Definition

A Person, Location/HealthcareService or Device that is participating in the appointment.

Comments

Data type

Reference(PCareLocation | PCarePatient | PCarePractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.who
v2: PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
rim: performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
ical: ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.actor.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

reference

O Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Appointment.participant.actor.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Comments

Data type

Binding

Aa resource (or, for logical models, the URI of the logical model).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

identifier

SO Σ

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

SO Σ

1..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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.

Comments

Identifier.system is always case sensitive.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Obligations

Code	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source	Name	Documentation
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/appointment-ca-core\|1.1.0
SHALL:populate-if-known	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:no-error	http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0
SHALL:populate SHALL:persist SHALL:no-error	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0	pcare	P-Care server population, persistence, and acceptance requirements for this element.

value

O Σ

1..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

period

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

display

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.actor.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

required

O Σ

0..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.participant.required

Short description

required | optional | information-only

Definition

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ParticipantRequired (required)

Binding

Is the Participant required to attend the appointment.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
rim: (performer | reusableDevice | subject | location).@performInd
ical: ROLE=REQ-PARTICIPANT (roleparam)

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

status

O Σ

1..1

codeBinding

There are no (further) constraints on this element

Element id

Appointment.participant.status

Short description

accepted | declined | tentative | needs-action

Definition

Participation status of the actor.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

ParticipationStatus (required)

Binding

The Participation status of an appointment.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

rim: n/a
v2: AIP-12, AIG-14
rim: (performer | reusableDevice | subject | location).statusCode
ical: ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

period

O C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.period

Short description

Participation period of the actor

Definition

Participation period of the actor.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.period.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Appointment.participant.period.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a

start

O Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.1
rim: ./low

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

end

O Σ C

0..1

There are no (further) constraints on this element

Element id

Appointment.participant.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Meaning when missing

If the end of the period is missing, it means that the period is ongoing

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: per-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())

Mappings

v2: DR.2
rim: ./high

Obligations

Name	Code	Documentation	Actor	Http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcare	SHALL:populate SHALL:persist SHALL:no-error	P-Care server population, persistence, and acceptance requirements for this element.	http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server	http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/appointment\|0.1.0

requestedPeriod

0..*

There are no (further) constraints on this element

Element id

Appointment.requestedPeriod

Short description

Potential date/time interval(s) requested to allocate the appointment within

Definition

A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

Comments

This does not introduce a capacity for recurring appointments.

Data type