Visit the HL7 website
Visit the FHIR website

Pan-Canadian Patient Summary (PS-CA)

current   Canada flag
  • Index
  • Home
  • Business Context
    • Use Cases
    • Requirements
    • Privacy and Security Guidance
    • Relationship to Other Specifications
  • Technical Context
    • Overview
    • Sequence Diagrams
    • Core Interoperability Specification Requirements
    • Conformance and Specification Guidance
    • General Principles & Design
  • FHIR Artifacts
    • FHIR Artifacts
    • PS-CA Library of Profiles
    • Bundle (PS-CA)
    • Composition (PS-CA)
    • Patient (PS-CA)
    • Medication (PS-CA)
    • MedicationRequest (PS-CA)
    • MedicationStatement (PS-CA)
    • AllergyIntolerance (PS-CA)
    • Condition (PS-CA)
    • Procedure (PS-CA)
    • Immunization (PS-CA)
    • DiagnosticReport (PS-CA)
    • ImagingStudy (PS-CA)
    • Organization (PS-CA)
    • Organization-Lab (PS-CA)
    • Practitioner (PS-CA)
    • Practitioner-Lab (PS-CA)
    • PractitionerRole (PS-CA)
    • PractitionerRole-Lab (PS-CA)
    • Observation Laboratory/Pathology (PS-CA)
    • Observation Radiology (PS-CA)
    • Observation Social History (PS-CA)
    • Observation Alcohol Use (PS-CA)
    • Observation Tobacco Use (PS-CA)
    • Family Member History (PS-CA)
    • Actors
    • Data Type Profiles
    • Extensions
    • Examples
    • Terminology
    • Downloads
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Bundle (PS-CA)

TI Ballot - For a full list of available versions, see the Directory of published versions

Bundle (PS-CA)

Links

Profile

bundle-ca-ps

Derived from

http://hl7.org/fhir/StructureDefinition/Bundle

Examples

Bundle1Example, Bundle-FulsomeClinicalScenario1, Bundle-FulsomeClinicalScenario2, Bundle-PSCA-2.0.0-AllProfiles

Description

This profile represents the constraints applied to the Bundle resource by the PS-CA project.

References to this resource

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
BundlePSCA (Bundle)CBundleElement id
Bundle
Short description

PS-CA Bundle

Definition

PS-CA Bundle. A container for a collection of resources in the patient summary.

Data type

Bundle

Constraints
  • bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
    (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
  • bdl-9: A document must have an identifier with a system and a value
    type = 'document' implies (identifier.system.exists() and identifier.value.exists())
  • bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited
    entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
  • bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
    entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
  • bdl-12: A message must have a MessageHeader as the first resource
    type = 'message' implies entry.first().resource.is(MessageHeader)
  • bdl-1: total only when a search or history
    total.empty() or (type = 'searchset') or (type = 'history')
  • bdl-2: entry.search only when a search
    entry.search.empty() or (type = 'searchset')
  • bdl-11: A document must have a Composition as the first resource
    type = 'document' implies entry.first().resource.is(Composition)
  • bdl-10: A document must have a date
    type = 'document' implies (timestamp.hasValue())
  • bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
    type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
  • bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
    type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
  • bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
    type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
  • bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
    type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
  • bdl-15: Bundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
    type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
  • bdl-ps-1: A PS document must have no additional Composition (including Composition subclass) resources besides the first
    entry.tail().where(resource is Composition).empty()
Mappings
  • rim: Entity. Role, or Act
  • v2: N/A
  • rim: N/A
  • cda: ClinicalDocument, if bundle.type = document
idΣ0..1id
There are no (further) constraints on this element
Element id
Bundle.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

id

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
metaΣ0..1Meta
There are no (further) constraints on this element
Element id
Bundle.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

Meta

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
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
Bundle.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

uri

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
language0..1codeBinding
There are no (further) constraints on this element
Element id
Bundle.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

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
MaxValueSetAllLanguages
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
identifierSO Σ1..1IdentifierElement id
Bundle.identifier
Short description

Persistent identifier for the bundle

Definition

A persistent identifier for the bundle that won't change as a bundle is copied from server to server.

Comments

Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.

Data type

Identifier

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
  • w5: FiveWs.identifier
  • cda: ClinicalDocument.id
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
typeSO Σ1..1codeBindingFixed ValueElement id
Bundle.type
Short description

document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection

Definition

Indicates the purpose of this bundle - how it is intended to be used.

Comments

It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.

Data type

code

Binding

Indicates the purpose of a bundle - how it is intended to be used.

BundleType (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())
Fixed value
document
Mappings
  • rim: n/a
  • w5: FiveWs.class
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
timestampSO Σ1..1instantElement id
Bundle.timestamp
Short description

When the bundle was assembled

Definition

The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Comments

For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.

Usage:

  • document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
  • message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
  • history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
  • searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
  • transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.

Data type

instant

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
  • w5: FiveWs.init
  • cda: ClinicalDocument.effectiveTime
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
totalΣ C0..1unsignedInt
There are no (further) constraints on this element
Element id
Bundle.total
Short description

If search, the total number of matches

Definition

If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.

Comments

Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.

Data type

unsignedInt

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
linkΣ0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.link
Short description

Links related to this Bundle

Definition

A series of links that provide context to this bundle.

Comments

Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS).

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly.

This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.

Data type

BackboneElement

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
entryΣ C2..*BackboneElementElement id
Bundle.entry
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

Slicing

Unordered, Open, by resource(Type), resource(Profile)

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
(All Slices)
The requirements in this element apply to all slices

id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ0..1Resource
There are no (further) constraints on this element
Element id
Bundle.entry.resource
Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
compositionSO Σ C1..1BackboneElementElement id
Bundle.entry:composition
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:composition.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:composition.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:composition.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:composition.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:composition.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceSO Σ C1..1CompositionPSCAElement id
Bundle.entry:composition.resource
Short description

Canadian Patient Summary composition

Definition

Canadian Patient Summary composition. A composition is a set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

Comments

While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

Data type

CompositionPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
  • cda: ClinicalDocument
  • fhirdocumentreference: when described by DocumentReference
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:composition.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:composition.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:composition.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
patientSO Σ C1..1BackboneElementElement id
Bundle.entry:patient
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:patient.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:patient.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:patient.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:patient.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:patient.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceSO Σ C1..1PatientPSCAElement id
Bundle.entry:patient.resource
Short description

Information about an individual or animal receiving health care services

Alternate names

SubjectOfCare Client Resident

Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Data type

PatientPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • rim: Patient[classCode=PAT]
  • cda: ClinicalDocument.recordTarget.patientRole
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:patient.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:patient.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:patient.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
allergyintoleranceΣ C0..*BackboneElementElement id
Bundle.entry:allergyintolerance
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:allergyintolerance.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1AllergyIntolerancePSCAElement id
Bundle.entry:allergyintolerance.resource
Short description

Allergy or Intolerance (generally: Risk of adverse reaction to a substance)

Alternate names

Allergy, Intolerance, Adverse Reaction

Definition

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Comments

Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.

Data type

AllergyIntolerancePSCA

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()
  • ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
  • ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
    verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
Mappings
  • rim: Entity. Role, or Act
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
careplanΣ C0..*BackboneElementElement id
Bundle.entry:careplan
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:careplan.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ1..1CarePlanElement id
Bundle.entry:careplan.resource
Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

CarePlan

Mappings
  • rim: Entity. Role, or Act
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
clinicalimpressionΣ C0..*BackboneElementElement id
Bundle.entry:clinicalimpression
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:clinicalimpression.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ1..1ClinicalImpressionElement id
Bundle.entry:clinicalimpression.resource
Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

ClinicalImpression

Mappings
  • rim: Entity. Role, or Act
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
conditionΣ C0..*BackboneElementElement id
Bundle.entry:condition
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:condition.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:condition.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:condition.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:condition.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:condition.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ConditionPSCAElement id
Bundle.entry:condition.resource
Short description

Detailed information about conditions, problems or diagnoses

Definition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Data type

ConditionPSCA

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()
  • con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
    verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
  • con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
    abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
  • con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
    clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)
  • v2: PPR message
  • rim: Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:condition.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:condition.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:condition.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
consentΣ C0..*BackboneElementElement id
Bundle.entry:consent
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:consent.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:consent.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:consent.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:consent.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:consent.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ1..1ConsentElement id
Bundle.entry:consent.resource
Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

Consent

Mappings
  • rim: Entity. Role, or Act
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:consent.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:consent.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:consent.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
deviceΣ C0..*BackboneElementElement id
Bundle.entry:device
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:device.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:device.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:device.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:device.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:device.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1DeviceUvIpsElement id
Bundle.entry:device.resource
Short description

Item used in healthcare

Definition

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Comments

This profile applies the rules defined by HL7 International for representing the UDI in the FHIR standard, by the document "Medical Devices and Unique Device Identification (UDI) Pattern, Release 1"

Data type

DeviceUvIps

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()
Mappings
  • rim: Entity. Role, or Act
  • rim: Device
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:device.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:device.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:device.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
deviceusestatementΣ C0..*BackboneElementElement id
Bundle.entry:deviceusestatement
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:deviceusestatement.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1DeviceUseStatementUvIpsElement id
Bundle.entry:deviceusestatement.resource
Short description

Record of use of a device

Definition

A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.

Data type

DeviceUseStatementUvIps

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • quick: DeviceUsePerformanceOccurrence
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
diagnosticreportΣ C0..*BackboneElementElement id
Bundle.entry:diagnosticreport
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:diagnosticreport.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1DiagnosticReportUvIpsElement id
Bundle.entry:diagnosticreport.resource
Short description

A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports

Alternate names

Report, Test, Result, Results, Labs, Laboratory

Definition

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

Comments

This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.

Data type

DiagnosticReportUvIps

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • v2: ORU -> OBR
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
documentreferenceΣ C0..*BackboneElementElement id
Bundle.entry:documentreference
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:documentreference.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ1..1DocumentReferenceElement id
Bundle.entry:documentreference.resource
Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

DocumentReference

Mappings
  • rim: Entity. Role, or Act
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
familymemberhistoryΣ C0..*BackboneElementElement id
Bundle.entry:familymemberhistory
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:familymemberhistory.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1FamilyMemberHistoryPSCAElement id
Bundle.entry:familymemberhistory.resource
Short description

Information about patient's relatives, relevant for patient

Definition

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

Data type

FamilyMemberHistoryPSCA

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()
  • fhs-2: Can only have estimatedAge if age[x] is present
    age.exists() or estimatedAge.empty()
  • fhs-1: Can have age[x] or born[x], but not both
    age.empty() or born.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • v2: Not in scope for v2
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
imagingstudyΣ C0..*BackboneElementElement id
Bundle.entry:imagingstudy
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:imagingstudy.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ImagingStudyPSCAElement id
Bundle.entry:imagingstudy.resource
Short description

A set of images produced in single study (one or more series of references images)

Definition

Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.

Comments

Preliminary analysis has identified that imaging study information may have limited support in current systems intending to produce a diagnostic results section in their initial patient summaries, further feedback and investigation is required with participating jurisdictions to confirm the support of any of the imaging study elements - until then, initial constraints put forth in the IPS-UV specification have been mantained.

Data type

ImagingStudyPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Act[classCode=COMPOSITION, moodCode=EVN]
  • dicom: Reference IHE radiology TF vol 2 table 4.14-1
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
immunizationΣ C0..*BackboneElementElement id
Bundle.entry:immunization
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:immunization.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ImmunizationPSCAElement id
Bundle.entry:immunization.resource
Short description

Immunization event information

Definition

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Data type

ImmunizationPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • v2: VXU_V04
  • rim: SubstanceAdministration
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
immunizationrecommendationΣ C0..*BackboneElementElement id
Bundle.entry:immunizationrecommendation
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:immunizationrecommendation.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ1..1ImmunizationRecommendationElement id
Bundle.entry:immunizationrecommendation.resource
Short description

A resource in the bundle

Definition

The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

Data type

ImmunizationRecommendation

Mappings
  • rim: Entity. Role, or Act
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
medicationΣ C0..*BackboneElementElement id
Bundle.entry:medication
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:medication.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:medication.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:medication.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:medication.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:medication.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1MedicationPSCAElement id
Bundle.entry:medication.resource
Short description

Definition of a Medication

Definition

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

Data type

MedicationPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • script10.6: NewRx/MedicationPrescribed -or- RxFill/MedicationDispensed -or- RxHistoryResponse/MedicationDispensed -or- RxHistoryResponse/MedicationPrescribed
  • rim: ManufacturedProduct[classCode=ADMM]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medication.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medication.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medication.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
medicationrequestΣ C0..*BackboneElementElement id
Bundle.entry:medicationrequest
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:medicationrequest.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1MedicationRequestPSCAElement id
Bundle.entry:medicationrequest.resource
Short description

Ordering of medication for patient or group

Alternate names

Prescription, Order

Definition

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

Comments

Jurisdictions mapping prescription data into FHIR profiles for the patient summary should support the MedicationRequest resource. Use of the MedicationStatement profile should be reserved for communicating a statement about the patient's usage of the medication that is ultimately provided by a patient, significant other, or a clinician.

The MedicationRequest resource is not included in the current (as of November 2021) published release of IPS (release 1.0.0, STU1), but is in the development preview of the next release.

Data type

MedicationRequestPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Request
  • script10.6: Message/Body/NewRx
  • rim: CombinedMedicationRequest
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
medicationstatementΣ C0..*BackboneElementElement id
Bundle.entry:medicationstatement
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:medicationstatement.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1MedicationStatementPSCAElement id
Bundle.entry:medicationstatement.resource
Short description

Record of medication being taken by a patient

Definition

A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains.

The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.

Comments

Jurisdictions mapping prescription data into FHIR profiles for the patient summary should use the MedicationRequest resource. Use of the MedicationStatement profile should be reserved for communicating a statement about the patient's usage of the medication that is ultimately provided by a patient, significant other, or a clinician.

Data type

MedicationStatementPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: SubstanceAdministration
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
practitionerΣ C0..*BackboneElementElement id
Bundle.entry:practitioner
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:practitioner.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1PractitionerLabPSCAElement id
Bundle.entry:practitioner.resource
Short description

A person with a formal responsibility in the provisioning of healthcare or related services

Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Data type

PractitionerLabPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • v2: PRD (as one example)
  • rim: Role
  • servd: Provider
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
practitionerroleΣ C0..*BackboneElementElement id
Bundle.entry:practitionerrole
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:practitionerrole.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1PractitionerRoleLabPSCAElement id
Bundle.entry:practitionerrole.resource
Short description

Roles/organizations the practitioner is associated with

Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Data type

PractitionerRoleLabPSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • v2: PRD (as one example)
  • rim: Role
  • servd: ServiceSiteProvider
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
procedureΣ C0..*BackboneElementElement id
Bundle.entry:procedure
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:procedure.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ProcedurePSCAElement id
Bundle.entry:procedure.resource
Short description

An action that is being or was performed on a patient

Definition

An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.

Data type

ProcedurePSCA

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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Procedure[moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-pregnancy-eddΣ C0..*BackboneElementElement id
Bundle.entry:observation-pregnancy-edd
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-pregnancy-edd.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ObservationPregnancyEddUvIpsElement id
Bundle.entry:observation-pregnancy-edd.resource
Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

ObservationPregnancyEddUvIps

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-pregnancy-outcomeΣ C0..*BackboneElementElement id
Bundle.entry:observation-pregnancy-outcome
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-pregnancy-outcome.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ObservationPregnancyOutcomeUvIpsElement id
Bundle.entry:observation-pregnancy-outcome.resource
Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

ObservationPregnancyOutcomeUvIps

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-pregnancy-statusΣ C0..*BackboneElementElement id
Bundle.entry:observation-pregnancy-status
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-pregnancy-status.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ObservationPregnancyStatusUvIpsElement id
Bundle.entry:observation-pregnancy-status.resource
Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

ObservationPregnancyStatusUvIps

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-alcohol-useΣ C0..*BackboneElementElement id
Bundle.entry:observation-alcohol-use
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-alcohol-use.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ObservationAlcoholUsePSCAElement id
Bundle.entry:observation-alcohol-use.resource
Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

ObservationAlcoholUsePSCA

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-tobacco-useΣ C0..*BackboneElementElement id
Bundle.entry:observation-tobacco-use
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-tobacco-use.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ObservationTobaccoUsePSCAElement id
Bundle.entry:observation-tobacco-use.resource
Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

ObservationTobaccoUsePSCA

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-results-laboratory-pathologyΣ C0..*BackboneElementElement id
Bundle.entry:observation-results-laboratory-pathology
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-results-laboratory-pathology.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ObservationResultsLaboratoryPathologyPSCAElement id
Bundle.entry:observation-results-laboratory-pathology.resource
Short description

Laboratory (including Pathology) result for a simple test or for a panel/study

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This observation may represent the result of a simple laboratory or pathology test such as hematocrit or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, or a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and references the atomic results of the study as "has-member" child observations

Comments

Represents either a lab simple observation or the group of observations produced by a laboratory study.

Data type

ObservationResultsLaboratoryPathologyPSCA

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • psca-lab-pat-1: At least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
    value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
  • psca-lab-pat-2: If observation has components, at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
    component.exists() implies (component.value.exists() or component.dataAbsentReason.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-results-radiologyΣ C0..*BackboneElementElement id
Bundle.entry:observation-results-radiology
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-results-radiology.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1ObservationResultsRadiologyPSCAElement id
Bundle.entry:observation-results-radiology.resource
Short description

Measurements and simple assertions

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

Measurements and simple assertions made about a patient, device or other subject.

Comments

Preliminary analysis has identified that radiology result information may have limited support in current systems intending to produce a diagnostic results section in their initial patient summaries, further feedback and investigation is required with participating jurisdictions to confirm the support of any of the radiology observation elements - until then, initial constraints put forth in the IPS-UV specification have been maintained with minimal relaxation.

Data type

ObservationResultsRadiologyPSCA

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • psca-rad-1: component and hasMember are mutually exclusive
    hasMember.empty() or component.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-bmiΣ C0..*BackboneElementElement id
Bundle.entry:observation-bmi
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-bmi.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-bmiElement id
Bundle.entry:observation-bmi.resource
Short description

FHIR Body Mass Index (BMI) Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent Body Mass Index (BMI) observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-bmi

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-bpΣ C0..*BackboneElementElement id
Bundle.entry:observation-bp
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-bp.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-bpElement id
Bundle.entry:observation-bp.resource
Short description

FHIR Blood Pressure Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent Blood Pressure observations in FHIR using a standard LOINC code and UCUM units of measure. This is a grouping structure. It has no value in Observation.valueQuantity but contains at least one component (systolic and/or diastolic).

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-bp

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-bodyheightΣ C0..*BackboneElementElement id
Bundle.entry:observation-bodyheight
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-bodyheight.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-bodyheightElement id
Bundle.entry:observation-bodyheight.resource
Short description

FHIR Body Height Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent Body Height observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-bodyheight

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-bodyweightΣ C0..*BackboneElementElement id
Bundle.entry:observation-bodyweight
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-bodyweight.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-bodyweightElement id
Bundle.entry:observation-bodyweight.resource
Short description

FHIR Body Weight Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent body weight observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-bodyweight

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-bodytempΣ C0..*BackboneElementElement id
Bundle.entry:observation-bodytemp
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-bodytemp.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-bodytempElement id
Bundle.entry:observation-bodytemp.resource
Short description

FHIR Body Temperature Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent Body Temperature observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-bodytemp

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-headcircumΣ C0..*BackboneElementElement id
Bundle.entry:observation-headcircum
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-headcircum.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-headcircumElement id
Bundle.entry:observation-headcircum.resource
Short description

FHIR Head Circumference Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent Head Circumference observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-headcircum

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-heartrateΣ C0..*BackboneElementElement id
Bundle.entry:observation-heartrate
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-heartrate.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-heartrateElement id
Bundle.entry:observation-heartrate.resource
Short description

FHIR Heart Rate Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent heart rate observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-heartrate

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-oxygensatΣ C0..*BackboneElementElement id
Bundle.entry:observation-oxygensat
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-oxygensat.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-oxygensatElement id
Bundle.entry:observation-oxygensat.resource
Short description

FHIR Oxygen Saturation Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent Oxygen Saturation observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-oxygensat

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-resprateΣ C0..*BackboneElementElement id
Bundle.entry:observation-resprate
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-resprate.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-resprateElement id
Bundle.entry:observation-resprate.resource
Short description

FHIR Respiratory Rate Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines how to represent Respiratory Rate observations in FHIR using a standard LOINC code and UCUM units of measure.

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-resprate

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
observation-vitalspanelΣ C0..*BackboneElementElement id
Bundle.entry:observation-vitalspanel
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:observation-vitalspanel.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1observation-vitalspanelElement id
Bundle.entry:observation-vitalspanel.resource
Short description

FHIR Vital Signs Panel Profile

Alternate names

Vital Signs, Measurement, Results, Tests

Definition

This profile defines the top-level grouping structure for a set of vital signs. It has no value in Observation.valueQuantity ; instead, it just includes related links (with type=has-member) to the Observations in this set (e.g. respiratory rate, heart rate, BP).

Comments

Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc.

Data type

observation-vitalspanel

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()
  • obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
    value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
  • obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
    dataAbsentReason.empty() or value.empty()
  • vs-2: If there is no component or hasMember element then either a value[x] or a data absent reason must be present.
    (component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 363787002 |Observable entity|
  • v2: OBX
  • rim: Observation[classCode=OBS, moodCode=EVN]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
organization-labΣ C0..*BackboneElementElement id
Bundle.entry:organization-lab
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:organization-lab.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1OrganizationLabPSCAElement id
Bundle.entry:organization-lab.resource
Short description

A grouping of people or organizations with a common purpose

Definition

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Data type

OrganizationLabPSCA

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()
  • org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
    (identifier.count() + name.count()) > 0
Mappings
  • rim: Entity. Role, or Act
  • v2: (also see master files messages)
  • rim: Organization(classCode=ORG, determinerCode=INST)
  • servd: Organization
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
specimenΣ C0..*BackboneElementElement id
Bundle.entry:specimen
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Data type

BackboneElement

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())
  • bdl-8: fullUrl cannot be a version specific reference
    fullUrl.exists() implies fullUrl.contains('/_history/').not()
  • bdl-5: must be a resource unless there's a request or response
    resource.exists() or request.exists() or response.exists()
Mappings
  • rim: n/a
id0..1string
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.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

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.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

Extension

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Σ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.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

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

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

Extension

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
linkΣ0..*see (link)
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.link
Short description

Links related to this entry

Definition

A series of links that provide context to this entry.

fullUrlSO Σ1..1uriElement id
Bundle.entry:specimen.fullUrl
Short description

URI for resource (Absolute URL server address or URI for UUID/OID)

Definition

The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

  • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
  • Results from operations might involve resources that are not identified.
Comments

fullUrl might not be unique in the context of a resource. Note that since FHIR resources do not need to be served through the FHIR API, the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the regex, then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).

Data type

uri

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
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceΣ C1..1SpecimenUvIpsElement id
Bundle.entry:specimen.resource
Short description

Sample for analysis

Definition

A sample to be used for analysis.

Data type

SpecimenUvIps

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()
Mappings
  • rim: Entity. Role, or Act
  • rim: Role[classCode=SPEC]
searchΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.search
Short description

Search related information

Definition

Information about the search process that lead to the creation of this entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
requestΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.request
Short description

Additional execution information (transaction/batch/history)

Definition

Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
responseΣ C0..0BackboneElement
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.response
Short description

Results of execution (transaction/batch/history)

Definition

Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.

Data type

BackboneElement

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
signatureΣ0..1Signature
There are no (further) constraints on this element
Element id
Bundle.signature
Short description

Digital Signature

Definition

Digital Signature - base64 encoded. XML-DSig or a JWT.

Requirements

A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.

Comments

The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.

Data type

Signature

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
BundlePSCA (Bundle)CBundle
There are no (further) constraints on this element
Element id
Bundle
Short description

PS-CA Bundle

Definition

PS-CA Bundle. A container for a collection of resources in the patient summary.

Data type

Bundle

Constraints
  • bdl-ps-1: A PS document must have no additional Composition (including Composition subclass) resources besides the first
    entry.tail().where(resource is Composition).empty()
identifierSO1..
There are no (further) constraints on this element
Element id
Bundle.identifier
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
typeSOFixed Value
There are no (further) constraints on this element
Element id
Bundle.type
Fixed value
document
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
timestampSO1..
There are no (further) constraints on this element
Element id
Bundle.timestamp
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
link..0
There are no (further) constraints on this element
Element id
Bundle.link
entry2..
There are no (further) constraints on this element
Element id
Bundle.entry
Short description

Entry resource in the patient summary bundle

Definition

An entry resource included in the patient summary bundle resource.

Comments

Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.

Slicing

Unordered, Open, by resource(Type), resource(Profile)

(All Slices)
The requirements in this element apply to all slices

fullUrlSO1..
There are no (further) constraints on this element
Element id
Bundle.entry.fullUrl
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
search..0
There are no (further) constraints on this element
Element id
Bundle.entry.search
request..0
There are no (further) constraints on this element
Element id
Bundle.entry.request
response..0
There are no (further) constraints on this element
Element id
Bundle.entry.response
compositionSO1..1
There are no (further) constraints on this element
Element id
Bundle.entry:composition
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceSO1..CompositionPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:composition.resource
Data type

CompositionPSCA

Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
patientSO1..1
There are no (further) constraints on this element
Element id
Bundle.entry:patient
Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
resourceSO1..PatientPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:patient.resource
Data type

PatientPSCA

Obligations
CodeActor
SHALL:populatehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHALL:handlehttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
SHOULD:displayhttp://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer
allergyintolerance0..*
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance
resource1..AllergyIntolerancePSCA
There are no (further) constraints on this element
Element id
Bundle.entry:allergyintolerance.resource
Data type

AllergyIntolerancePSCA

careplan0..*
There are no (further) constraints on this element
Element id
Bundle.entry:careplan
resource1..CarePlan
There are no (further) constraints on this element
Element id
Bundle.entry:careplan.resource
Data type

CarePlan

clinicalimpression0..*
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression
resource1..ClinicalImpression
There are no (further) constraints on this element
Element id
Bundle.entry:clinicalimpression.resource
Data type

ClinicalImpression

condition0..*
There are no (further) constraints on this element
Element id
Bundle.entry:condition
resource1..ConditionPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:condition.resource
Data type

ConditionPSCA

consent0..*
There are no (further) constraints on this element
Element id
Bundle.entry:consent
resource1..Consent
There are no (further) constraints on this element
Element id
Bundle.entry:consent.resource
Data type

Consent

device0..*
There are no (further) constraints on this element
Element id
Bundle.entry:device
resource1..DeviceUvIps
There are no (further) constraints on this element
Element id
Bundle.entry:device.resource
Data type

DeviceUvIps

deviceusestatement0..*
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement
resource1..DeviceUseStatementUvIps
There are no (further) constraints on this element
Element id
Bundle.entry:deviceusestatement.resource
Data type

DeviceUseStatementUvIps

diagnosticreport0..*
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport
resource1..DiagnosticReportUvIps
There are no (further) constraints on this element
Element id
Bundle.entry:diagnosticreport.resource
Data type

DiagnosticReportUvIps

documentreference0..*
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference
resource1..DocumentReference
There are no (further) constraints on this element
Element id
Bundle.entry:documentreference.resource
Data type

DocumentReference

familymemberhistory0..*
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory
resource1..FamilyMemberHistoryPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:familymemberhistory.resource
Data type

FamilyMemberHistoryPSCA

imagingstudy0..*
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy
resource1..ImagingStudyPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:imagingstudy.resource
Data type

ImagingStudyPSCA

immunization0..*
There are no (further) constraints on this element
Element id
Bundle.entry:immunization
resource1..ImmunizationPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:immunization.resource
Data type

ImmunizationPSCA

immunizationrecommendation0..*
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation
resource1..ImmunizationRecommendation
There are no (further) constraints on this element
Element id
Bundle.entry:immunizationrecommendation.resource
Data type

ImmunizationRecommendation

medication0..*
There are no (further) constraints on this element
Element id
Bundle.entry:medication
resource1..MedicationPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:medication.resource
Data type

MedicationPSCA

medicationrequest0..*
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest
resource1..MedicationRequestPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:medicationrequest.resource
Data type

MedicationRequestPSCA

medicationstatement0..*
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement
resource1..MedicationStatementPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:medicationstatement.resource
Data type

MedicationStatementPSCA

practitioner0..*
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner
resource1..PractitionerLabPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:practitioner.resource
Data type

PractitionerLabPSCA

practitionerrole0..*
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole
resource1..PractitionerRoleLabPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:practitionerrole.resource
Data type

PractitionerRoleLabPSCA

procedure0..*
There are no (further) constraints on this element
Element id
Bundle.entry:procedure
resource1..ProcedurePSCA
There are no (further) constraints on this element
Element id
Bundle.entry:procedure.resource
Data type

ProcedurePSCA

observation-pregnancy-edd0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd
resource1..ObservationPregnancyEddUvIps
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-edd.resource
Data type

ObservationPregnancyEddUvIps

observation-pregnancy-outcome0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome
resource1..ObservationPregnancyOutcomeUvIps
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-outcome.resource
Data type

ObservationPregnancyOutcomeUvIps

observation-pregnancy-status0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status
resource1..ObservationPregnancyStatusUvIps
There are no (further) constraints on this element
Element id
Bundle.entry:observation-pregnancy-status.resource
Data type

ObservationPregnancyStatusUvIps

observation-alcohol-use0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use
resource1..ObservationAlcoholUsePSCA
There are no (further) constraints on this element
Element id
Bundle.entry:observation-alcohol-use.resource
Data type

ObservationAlcoholUsePSCA

observation-tobacco-use0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use
resource1..ObservationTobaccoUsePSCA
There are no (further) constraints on this element
Element id
Bundle.entry:observation-tobacco-use.resource
Data type

ObservationTobaccoUsePSCA

observation-results-laboratory-pathology0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology
resource1..ObservationResultsLaboratoryPathologyPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-laboratory-pathology.resource
Data type

ObservationResultsLaboratoryPathologyPSCA

observation-results-radiology0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology
resource1..ObservationResultsRadiologyPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:observation-results-radiology.resource
Data type

ObservationResultsRadiologyPSCA

observation-bmi0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi
resource1..observation-bmi
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bmi.resource
Data type

observation-bmi

observation-bp0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp
resource1..observation-bp
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bp.resource
Data type

observation-bp

observation-bodyheight0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight
resource1..observation-bodyheight
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyheight.resource
Data type

observation-bodyheight

observation-bodyweight0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight
resource1..observation-bodyweight
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodyweight.resource
Data type

observation-bodyweight

observation-bodytemp0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp
resource1..observation-bodytemp
There are no (further) constraints on this element
Element id
Bundle.entry:observation-bodytemp.resource
Data type

observation-bodytemp

observation-headcircum0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum
resource1..observation-headcircum
There are no (further) constraints on this element
Element id
Bundle.entry:observation-headcircum.resource
Data type

observation-headcircum

observation-heartrate0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate
resource1..observation-heartrate
There are no (further) constraints on this element
Element id
Bundle.entry:observation-heartrate.resource
Data type

observation-heartrate

observation-oxygensat0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat
resource1..observation-oxygensat
There are no (further) constraints on this element
Element id
Bundle.entry:observation-oxygensat.resource
Data type

observation-oxygensat

observation-resprate0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate
resource1..observation-resprate
There are no (further) constraints on this element
Element id
Bundle.entry:observation-resprate.resource
Data type

observation-resprate

observation-vitalspanel0..*
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel
resource1..observation-vitalspanel
There are no (further) constraints on this element
Element id
Bundle.entry:observation-vitalspanel.resource
Data type

observation-vitalspanel

organization-lab0..*
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab
resource1..OrganizationLabPSCA
There are no (further) constraints on this element
Element id
Bundle.entry:organization-lab.resource
Data type

OrganizationLabPSCA

specimen0..*
There are no (further) constraints on this element
Element id
Bundle.entry:specimen
resource1..SpecimenUvIps
There are no (further) constraints on this element
Element id
Bundle.entry:specimen.resource
Data type

SpecimenUvIps

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="bundle-ca-ps" />
<url value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/bundle-ca-ps" />
<version value="2.2.0" />
<name value="BundlePSCA" />
<title value="Bundle (PS-CA)" />
<status value="draft" />
<experimental value="false" />
<date value="2024-04-09T00:00:00-08:00" />
<description value="This profile represents the constraints applied to the Bundle resource by the PS-CA project." />
<copyright value="Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Bundle" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Bundle" />
<derivation value="constraint" />
<differential>
<element id="Bundle">
<path value="Bundle" />
<short value="PS-CA Bundle" />
<definition value="PS-CA Bundle. \nA container for a collection of resources in the patient summary." />
<constraint>
<key value="bdl-ps-1" />
<severity value="error" />
<human value="A PS document must have no additional Composition (including Composition subclass) resources besides the first" />
<expression value="entry.tail().where(resource is Composition).empty()" />
<source value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/bundle-ca-ps" />
</constraint>
</element>
<element id="Bundle.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.identifier" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.type">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.type" />
<fixedCode value="document" />
<mustSupport value="true" />
</element>
<element id="Bundle.timestamp">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.timestamp" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.link">
<path value="Bundle.link" />
<max value="0" />
</element>
<element id="Bundle.entry">
<path value="Bundle.entry" />
<slicing>
<discriminator>
<type value="type" />
<path value="resource" />
</discriminator>
<discriminator>
<type value="profile" />
<path value="resource" />
</discriminator>
<rules value="open" />
</slicing>
<short value="Entry resource in the patient summary bundle" />
<definition value="An entry resource included in the patient summary bundle resource." />
<comment value="Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile." />
<min value="2" />
</element>
<element id="Bundle.entry.fullUrl">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.entry.fullUrl" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry.search">
<path value="Bundle.entry.search" />
<max value="0" />
</element>
<element id="Bundle.entry.request">
<path value="Bundle.entry.request" />
<max value="0" />
</element>
<element id="Bundle.entry.response">
<path value="Bundle.entry.response" />
<max value="0" />
</element>
<element id="Bundle.entry:composition">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.entry" />
<sliceName value="composition" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:composition.resource">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Composition" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/composition-ca-ps" />
</type>
<mustSupport value="true" />
</element>
<element id="Bundle.entry:patient">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.entry" />
<sliceName value="patient" />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Bundle.entry:patient.resource">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:handle" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Patient" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps" />
</type>
<mustSupport value="true" />
</element>
<element id="Bundle.entry:allergyintolerance">
<path value="Bundle.entry" />
<sliceName value="allergyintolerance" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:allergyintolerance.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="AllergyIntolerance" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/allergyintolerance-ca-ps" />
</type>
</element>
<element id="Bundle.entry:careplan">
<path value="Bundle.entry" />
<sliceName value="careplan" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:careplan.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="CarePlan" />
</type>
</element>
<element id="Bundle.entry:clinicalimpression">
<path value="Bundle.entry" />
<sliceName value="clinicalimpression" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:clinicalimpression.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="ClinicalImpression" />
</type>
<mustSupport value="false" />
</element>
<element id="Bundle.entry:condition">
<path value="Bundle.entry" />
<sliceName value="condition" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:condition.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Condition" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/condition-ca-ps" />
</type>
</element>
<element id="Bundle.entry:consent">
<path value="Bundle.entry" />
<sliceName value="consent" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:consent.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Consent" />
</type>
</element>
<element id="Bundle.entry:device">
<path value="Bundle.entry" />
<sliceName value="device" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:device.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Device" />
<profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Device-uv-ips" />
</type>
</element>
<element id="Bundle.entry:deviceusestatement">
<path value="Bundle.entry" />
<sliceName value="deviceusestatement" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:deviceusestatement.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="DeviceUseStatement" />
<profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips" />
</type>
</element>
<element id="Bundle.entry:diagnosticreport">
<path value="Bundle.entry" />
<sliceName value="diagnosticreport" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:diagnosticreport.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="DiagnosticReport" />
<profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips" />
</type>
</element>
<element id="Bundle.entry:documentreference">
<path value="Bundle.entry" />
<sliceName value="documentreference" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:documentreference.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="DocumentReference" />
</type>
</element>
<element id="Bundle.entry:familymemberhistory">
<path value="Bundle.entry" />
<sliceName value="familymemberhistory" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:familymemberhistory.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="FamilyMemberHistory" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/familymemberhistory-ca-ps" />
</type>
</element>
<element id="Bundle.entry:imagingstudy">
<path value="Bundle.entry" />
<sliceName value="imagingstudy" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:imagingstudy.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="ImagingStudy" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/imagingstudy-ca-ps" />
</type>
</element>
<element id="Bundle.entry:immunization">
<path value="Bundle.entry" />
<sliceName value="immunization" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:immunization.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Immunization" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/immunization-ca-ps" />
</type>
</element>
<element id="Bundle.entry:immunizationrecommendation">
<path value="Bundle.entry" />
<sliceName value="immunizationrecommendation" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:immunizationrecommendation.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="ImmunizationRecommendation" />
</type>
</element>
<element id="Bundle.entry:medication">
<path value="Bundle.entry" />
<sliceName value="medication" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:medication.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Medication" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/medication-ca-ps" />
</type>
</element>
<element id="Bundle.entry:medicationrequest">
<path value="Bundle.entry" />
<sliceName value="medicationrequest" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:medicationrequest.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="MedicationRequest" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/medicationrequest-ca-ps" />
</type>
</element>
<element id="Bundle.entry:medicationstatement">
<path value="Bundle.entry" />
<sliceName value="medicationstatement" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:medicationstatement.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="MedicationStatement" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/medicationstatement-ca-ps" />
</type>
</element>
<element id="Bundle.entry:practitioner">
<path value="Bundle.entry" />
<sliceName value="practitioner" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:practitioner.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Practitioner" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitioner-lab-ca-ps" />
</type>
</element>
<element id="Bundle.entry:practitionerrole">
<path value="Bundle.entry" />
<sliceName value="practitionerrole" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:practitionerrole.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="PractitionerRole" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitionerrole-lab-ca-ps" />
</type>
</element>
<element id="Bundle.entry:procedure">
<path value="Bundle.entry" />
<sliceName value="procedure" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:procedure.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Procedure" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/procedure-ca-ps" />
</type>
</element>
<element id="Bundle.entry:observation-pregnancy-edd">
<path value="Bundle.entry" />
<sliceName value="observation-pregnancy-edd" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-pregnancy-edd.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-edd-uv-ips" />
</type>
</element>
<element id="Bundle.entry:observation-pregnancy-outcome">
<path value="Bundle.entry" />
<sliceName value="observation-pregnancy-outcome" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-pregnancy-outcome.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-outcome-uv-ips" />
</type>
</element>
<element id="Bundle.entry:observation-pregnancy-status">
<path value="Bundle.entry" />
<sliceName value="observation-pregnancy-status" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-pregnancy-status.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips" />
</type>
</element>
<element id="Bundle.entry:observation-alcohol-use">
<path value="Bundle.entry" />
<sliceName value="observation-alcohol-use" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-alcohol-use.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-alcoholuse-ca-ps" />
</type>
</element>
<element id="Bundle.entry:observation-tobacco-use">
<path value="Bundle.entry" />
<sliceName value="observation-tobacco-use" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-tobacco-use.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-tobaccouse-ca-ps" />
</type>
</element>
<element id="Bundle.entry:observation-results-laboratory-pathology">
<path value="Bundle.entry" />
<sliceName value="observation-results-laboratory-pathology" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-results-laboratory-pathology.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-results-laboratory-pathology-ca-ps" />
</type>
</element>
<element id="Bundle.entry:observation-results-radiology">
<path value="Bundle.entry" />
<sliceName value="observation-results-radiology" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-results-radiology.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-results-radiology-ca-ps" />
</type>
</element>
<element id="Bundle.entry:observation-bmi">
<path value="Bundle.entry" />
<sliceName value="observation-bmi" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-bmi.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/bmi" />
</type>
</element>
<element id="Bundle.entry:observation-bp">
<path value="Bundle.entry" />
<sliceName value="observation-bp" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-bp.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/bp" />
</type>
</element>
<element id="Bundle.entry:observation-bodyheight">
<path value="Bundle.entry" />
<sliceName value="observation-bodyheight" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-bodyheight.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/bodyheight" />
</type>
</element>
<element id="Bundle.entry:observation-bodyweight">
<path value="Bundle.entry" />
<sliceName value="observation-bodyweight" />
<min value="0" />
<max value="*" />
</element>
<element id="Bundle.entry:observation-bodyweight.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/bodyweight" />
</type>
</element>
<element id="Bundle.entry:observation-bodytemp">
<path value="Bundle.entry" />
<sliceName value="observation-bodytemp" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-bodytemp.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/bodytemp" />
</type>
</element>
<element id="Bundle.entry:observation-headcircum">
<path value="Bundle.entry" />
<sliceName value="observation-headcircum" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-headcircum.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/headcircum" />
</type>
</element>
<element id="Bundle.entry:observation-heartrate">
<path value="Bundle.entry" />
<sliceName value="observation-heartrate" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-heartrate.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/heartrate" />
</type>
</element>
<element id="Bundle.entry:observation-oxygensat">
<path value="Bundle.entry" />
<sliceName value="observation-oxygensat" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-oxygensat.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/oxygensat" />
</type>
</element>
<element id="Bundle.entry:observation-resprate">
<path value="Bundle.entry" />
<sliceName value="observation-resprate" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-resprate.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/resprate" />
</type>
</element>
<element id="Bundle.entry:observation-vitalspanel">
<path value="Bundle.entry" />
<sliceName value="observation-vitalspanel" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:observation-vitalspanel.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Observation" />
<profile value="http://hl7.org/fhir/StructureDefinition/vitalspanel" />
</type>
</element>
<element id="Bundle.entry:organization-lab">
<path value="Bundle.entry" />
<sliceName value="organization-lab" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:organization-lab.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Organization" />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/organization-lab-ca-ps" />
</type>
</element>
<element id="Bundle.entry:specimen">
<path value="Bundle.entry" />
<sliceName value="specimen" />
<min value="0" />
<max value="*" />
<mustSupport value="false" />
</element>
<element id="Bundle.entry:specimen.resource">
<path value="Bundle.entry.resource" />
<min value="1" />
<type>
<code value="Specimen" />
<profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips" />
</type>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "bundle-ca-ps",
"url": "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/bundle-ca-ps",
"version": "2.2.0",
"name": "BundlePSCA",
"title": "Bundle (PS-CA)",
"status": "draft",
"experimental": false,
"date": "2024-04-09T00:00:00-08:00",
"description": "This profile represents the constraints applied to the Bundle resource by the PS-CA project.",
"copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Bundle",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Bundle",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Bundle",
"path": "Bundle",
"short": "PS-CA Bundle",
"definition": "PS-CA Bundle. \nA container for a collection of resources in the patient summary.",
"constraint": [
{
"key": "bdl-ps-1",
"severity": "error",
"human": "A PS document must have no additional Composition (including Composition subclass) resources besides the first",
"expression": "entry.tail().where(resource is Composition).empty()",
"source": "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/bundle-ca-ps"
}
]
},
{
"id": "Bundle.identifier",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.identifier",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.type",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.type",
"fixedCode": "document",
"mustSupport": true
},
{
"id": "Bundle.timestamp",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.timestamp",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.link",
"path": "Bundle.link",
"max": "0"
},
{
"id": "Bundle.entry",
"path": "Bundle.entry",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "resource"
},
{
"type": "profile",
"path": "resource"
}
],
"rules": "open"
},
"short": "Entry resource in the patient summary bundle",
"definition": "An entry resource included in the patient summary bundle resource.",
"comment": "Must contain at a minimum the PS-CA Composition as the first entry (only a single Composition resource may be included) and a Patient Resource. Additional constraints that determine what is included in the bundle are specified in the PS-CA Composition profile.",
"min": 2
},
{
"id": "Bundle.entry.fullUrl",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.entry.fullUrl",
"min": 1,
"mustSupport": true
},
{
"id": "Bundle.entry.search",
"path": "Bundle.entry.search",
"max": "0"
},
{
"id": "Bundle.entry.request",
"path": "Bundle.entry.request",
"max": "0"
},
{
"id": "Bundle.entry.response",
"path": "Bundle.entry.response",
"max": "0"
},
{
"id": "Bundle.entry:composition",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.entry",
"sliceName": "composition",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Bundle.entry:composition.resource",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Composition",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/composition-ca-ps"
]
}
],
"mustSupport": true
},
{
"id": "Bundle.entry:patient",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.entry",
"sliceName": "patient",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Bundle.entry:patient.resource",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:handle"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHOULD:display"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Patient",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps"
]
}
],
"mustSupport": true
},
{
"id": "Bundle.entry:allergyintolerance",
"path": "Bundle.entry",
"sliceName": "allergyintolerance",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:allergyintolerance.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "AllergyIntolerance",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/allergyintolerance-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:careplan",
"path": "Bundle.entry",
"sliceName": "careplan",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:careplan.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "CarePlan"
}
]
},
{
"id": "Bundle.entry:clinicalimpression",
"path": "Bundle.entry",
"sliceName": "clinicalimpression",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:clinicalimpression.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "ClinicalImpression"
}
],
"mustSupport": false
},
{
"id": "Bundle.entry:condition",
"path": "Bundle.entry",
"sliceName": "condition",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:condition.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Condition",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/condition-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:consent",
"path": "Bundle.entry",
"sliceName": "consent",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:consent.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Consent"
}
]
},
{
"id": "Bundle.entry:device",
"path": "Bundle.entry",
"sliceName": "device",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:device.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Device",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Device-uv-ips"
]
}
]
},
{
"id": "Bundle.entry:deviceusestatement",
"path": "Bundle.entry",
"sliceName": "deviceusestatement",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:deviceusestatement.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "DeviceUseStatement",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips"
]
}
]
},
{
"id": "Bundle.entry:diagnosticreport",
"path": "Bundle.entry",
"sliceName": "diagnosticreport",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:diagnosticreport.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "DiagnosticReport",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips"
]
}
]
},
{
"id": "Bundle.entry:documentreference",
"path": "Bundle.entry",
"sliceName": "documentreference",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:documentreference.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "DocumentReference"
}
]
},
{
"id": "Bundle.entry:familymemberhistory",
"path": "Bundle.entry",
"sliceName": "familymemberhistory",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:familymemberhistory.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "FamilyMemberHistory",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/familymemberhistory-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:imagingstudy",
"path": "Bundle.entry",
"sliceName": "imagingstudy",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:imagingstudy.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "ImagingStudy",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/imagingstudy-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:immunization",
"path": "Bundle.entry",
"sliceName": "immunization",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:immunization.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Immunization",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/immunization-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:immunizationrecommendation",
"path": "Bundle.entry",
"sliceName": "immunizationrecommendation",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:immunizationrecommendation.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "ImmunizationRecommendation"
}
]
},
{
"id": "Bundle.entry:medication",
"path": "Bundle.entry",
"sliceName": "medication",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:medication.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Medication",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/medication-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:medicationrequest",
"path": "Bundle.entry",
"sliceName": "medicationrequest",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:medicationrequest.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "MedicationRequest",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/medicationrequest-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:medicationstatement",
"path": "Bundle.entry",
"sliceName": "medicationstatement",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:medicationstatement.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "MedicationStatement",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/medicationstatement-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:practitioner",
"path": "Bundle.entry",
"sliceName": "practitioner",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:practitioner.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Practitioner",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitioner-lab-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:practitionerrole",
"path": "Bundle.entry",
"sliceName": "practitionerrole",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:practitionerrole.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "PractitionerRole",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/practitionerrole-lab-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:procedure",
"path": "Bundle.entry",
"sliceName": "procedure",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:procedure.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Procedure",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/procedure-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:observation-pregnancy-edd",
"path": "Bundle.entry",
"sliceName": "observation-pregnancy-edd",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-pregnancy-edd.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-edd-uv-ips"
]
}
]
},
{
"id": "Bundle.entry:observation-pregnancy-outcome",
"path": "Bundle.entry",
"sliceName": "observation-pregnancy-outcome",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-pregnancy-outcome.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-outcome-uv-ips"
]
}
]
},
{
"id": "Bundle.entry:observation-pregnancy-status",
"path": "Bundle.entry",
"sliceName": "observation-pregnancy-status",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-pregnancy-status.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips"
]
}
]
},
{
"id": "Bundle.entry:observation-alcohol-use",
"path": "Bundle.entry",
"sliceName": "observation-alcohol-use",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-alcohol-use.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-alcoholuse-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:observation-tobacco-use",
"path": "Bundle.entry",
"sliceName": "observation-tobacco-use",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-tobacco-use.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-tobaccouse-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:observation-results-laboratory-pathology",
"path": "Bundle.entry",
"sliceName": "observation-results-laboratory-pathology",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-results-laboratory-pathology.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-results-laboratory-pathology-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:observation-results-radiology",
"path": "Bundle.entry",
"sliceName": "observation-results-radiology",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-results-radiology.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/observation-results-radiology-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:observation-bmi",
"path": "Bundle.entry",
"sliceName": "observation-bmi",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-bmi.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bmi"
]
}
]
},
{
"id": "Bundle.entry:observation-bp",
"path": "Bundle.entry",
"sliceName": "observation-bp",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-bp.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bp"
]
}
]
},
{
"id": "Bundle.entry:observation-bodyheight",
"path": "Bundle.entry",
"sliceName": "observation-bodyheight",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-bodyheight.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodyheight"
]
}
]
},
{
"id": "Bundle.entry:observation-bodyweight",
"path": "Bundle.entry",
"sliceName": "observation-bodyweight",
"min": 0,
"max": "*"
},
{
"id": "Bundle.entry:observation-bodyweight.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodyweight"
]
}
]
},
{
"id": "Bundle.entry:observation-bodytemp",
"path": "Bundle.entry",
"sliceName": "observation-bodytemp",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-bodytemp.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp"
]
}
]
},
{
"id": "Bundle.entry:observation-headcircum",
"path": "Bundle.entry",
"sliceName": "observation-headcircum",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-headcircum.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/headcircum"
]
}
]
},
{
"id": "Bundle.entry:observation-heartrate",
"path": "Bundle.entry",
"sliceName": "observation-heartrate",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-heartrate.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/heartrate"
]
}
]
},
{
"id": "Bundle.entry:observation-oxygensat",
"path": "Bundle.entry",
"sliceName": "observation-oxygensat",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-oxygensat.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/oxygensat"
]
}
]
},
{
"id": "Bundle.entry:observation-resprate",
"path": "Bundle.entry",
"sliceName": "observation-resprate",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-resprate.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/resprate"
]
}
]
},
{
"id": "Bundle.entry:observation-vitalspanel",
"path": "Bundle.entry",
"sliceName": "observation-vitalspanel",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:observation-vitalspanel.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Observation",
"profile": [
"http://hl7.org/fhir/StructureDefinition/vitalspanel"
]
}
]
},
{
"id": "Bundle.entry:organization-lab",
"path": "Bundle.entry",
"sliceName": "organization-lab",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:organization-lab.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Organization",
"profile": [
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/organization-lab-ca-ps"
]
}
]
},
{
"id": "Bundle.entry:specimen",
"path": "Bundle.entry",
"sliceName": "specimen",
"min": 0,
"max": "*",
"mustSupport": false
},
{
"id": "Bundle.entry:specimen.resource",
"path": "Bundle.entry.resource",
"min": 1,
"type": [
{
"code": "Specimen",
"profile": [
"http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips"
]
}
]
}
]
}
}

Terminology bindings (Differential)

Terminology bindings (Snapshot)

Constraints

PathIdGradeDetailsExpression
Bundlebdl-ps-1errorA PS document must have no additional Composition (including Composition subclass) resources besides the firstentry.tail().where(resource is Composition).empty()

Key Differences between the IPS-UV and PS-CA

  • Bundle.type and Bundle.entry.fullUrl elements are not Must Support (MS) in IPS-UV and are MS in PS-CA.
  • Bundle.entry:composition.resource element is not MS in IPS-UV, but it is MS in PS-CA.
  • Bundle.entry:patient and Bundle.entry:patient.resource elements are not MS in IPS-UV and MS in PS-CA.

IG © based on FHIR R4 | Package project:PS-CA-R1
Copyright © 2026 Canada Health Infoway. All rights reserved. Terms of Use & License Agreements. Privacy Policy.
HL7® and FHIR® are the registered trademarks of Health Level Seven International