Visit the HL7 website
Visit the FHIR website

Primary Care

0.1.0-dft-preBallot   Canada flag
  • Index
  • Home
  • Business Context
    • Architectural Considerations
    • Use Cases
    • Future Enhancements
    • Consolidation Methodology
  • Technical Context
    • Conformance Guidance
    • Mappings
  • FHIR Artifacts
    • FHIR Artifacts
    • Actors
    • Profiles
    • Extensions
    • Search
    • Data Types
    • Capability Statement
    • Terminology
    • Examples
    • Packages
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Profiles
    4. DocumentReference

dft-preBallot - This is the first draft of the P-Care IG. For a full list of available versions, see the Directory of published versions

DocumentReference

Links

Profile

document-reference

Derived from

http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core

Examples

Document Reference Example 1, Document Reference Example 2, Document Reference Example 3

Description

A reference to a document of any kind for any purpose.

References to this resource

PCareCommunication, PCareServiceRequest

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
PCareDocumentReference (DocumentReference)CDocumentReferenceCACore
There are no (further) constraints on this element
Element id
DocumentReference
Short description

A reference to a document

Definition

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

DocumentReferenceCACore

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
  • fhircomposition: when describing a Composition
  • rim: Document[classCode="DOC" and moodCode="EVN"]
  • cda: when describing a CDA
idΣ0..1id
There are no (further) constraints on this element
Element id
DocumentReference.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
metaO Σ0..1MetaElement id
DocumentReference.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
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.meta.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
DocumentReference.meta.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

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

Version specific identifier

Definition

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

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

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
lastUpdatedΣ0..1instant
There are no (further) constraints on this element
Element id
DocumentReference.meta.lastUpdated
Short description

When the resource version last changed

Definition

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

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

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
sourceΣ0..1uri
There are no (further) constraints on this element
Element id
DocumentReference.meta.source
Short description

Identifies where the resource comes from

Definition

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

Comments

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

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

Data type

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
profileO Σ0..*canonical(StructureDefinition)Element id
DocumentReference.meta.profile
Short description

Profiles this resource claims to conform to

Definition

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

Comments

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

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be 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
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
securityΣ0..*CodingBinding
There are no (further) constraints on this element
Element id
DocumentReference.meta.security
Short description

Security Labels applied to this resource

Definition

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

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
tagΣ0..*Coding
There are no (further) constraints on this element
Element id
DocumentReference.meta.tag
Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

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

CommonTags (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
DocumentReference.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
DocumentReference.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
text0..1Narrative
There are no (further) constraints on this element
Element id
DocumentReference.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

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

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
DocumentReference.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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

Comments

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

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
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 resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

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
DocumentReference.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

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

Requirements

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

Comments

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
masterIdentifierΣ0..1Identifier
There are no (further) constraints on this element
Element id
DocumentReference.masterIdentifier
Short description

Master Version Specific Identifier

Definition

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

Requirements

The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).

Comments

CDA Document Id extension and root.

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
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • fhircomposition: Composition.identifier
  • v2: TXA-12
  • rim: .id
  • xds: DocumentEntry.uniqueId
  • cda: ClinicalDocument/id
identifierSO Σ0..*IdentifierElement id
DocumentReference.identifier
Short description

Other identifiers for the document

Definition

Other identifiers associated with the document, including version independent identifiers.

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
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • v2: TXA-16?
  • rim: .id / .setId
  • xds: DocumentEntry.entryUUID
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
DocumentReference.identifier.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
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
systemSO Σ1..1uriElement id
DocumentReference.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

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())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
valueSO Σ1..1stringElement id
DocumentReference.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Comments

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

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

Data type

Period

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ C0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
statusO Σ ?!1..1codeBindingPatternElement id
DocumentReference.status
Short description

current | superseded | entered-in-error

Definition

The status of this document reference.

Comments

This is the status of the DocumentReference object, which might be independent from the docStatus element.

This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

Data type

code

Binding

The status of the document reference.

DocumentReferenceStatus (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())
Pattern
current
Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • v2: TXA-19
  • rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
  • xds: DocumentEntry.availabilityStatus
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
docStatusΣ0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.docStatus
Short description

preliminary | final | amended | entered-in-error

Definition

The status of the underlying document.

Comments

The document that is pointed to might be in various lifecycle states.

Data type

code

Binding

Status of the underlying document.

CompositionStatus (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • fhircomposition: Composition.status
  • v2: TXA-17
  • rim: .statusCode
typeSO Σ0..1CodeableConceptBindingElement id
DocumentReference.type
Short description

Kind of document (LOINC if possible)

Definition

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

Comments

Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

Data type

CodeableConcept

Binding

Precise type of clinical document.

DocumentTypeValueSet (preferred)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.code
  • w5: FiveWs.class
  • fhircomposition: Composition.type
  • v2: TXA-2
  • rim: ./code
  • xds: DocumentEntry.type
  • cda: ClinicalDocument/code/@code The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
categoryΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.category
Short description

Categorization of document

Alternate names

claxs

Definition

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

Comments

Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

Data type

CodeableConcept

Binding

High-level kind of a clinical document at a macro level.

DocumentClassValueSet (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • fhircomposition: Composition.class
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • xds: DocumentEntry.class
  • cda: Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code
subjectSO Σ C0..1Reference(PCarePatient)Element id
DocumentReference.subject
Short description

Who/what is the subject of the document

Definition

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

Comments

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

Data type

Reference(PCarePatient)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • fhircomposition: Composition.subject
  • v2: PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • xds: DocumentEntry.patientId
  • cda: ClinicalDocument/recordTarget/
  • w5: FiveWs.subject
  • CACDI: Patient
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.subject.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
DocumentReference.subject.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
referenceO Σ C0..1stringElement id
DocumentReference.subject.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

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

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
DocumentReference.subject.type
Short description

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

Definition

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

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

Comments

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

Data type

uri

Binding

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

ResourceType (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
identifierO Σ0..1IdentifierElement id
DocumentReference.subject.identifier
Short description

Logical reference, when literal reference is not known

Definition

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

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

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

Data type

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
  • rim: .identifier
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.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
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
systemO Σ1..1uriElement id
DocumentReference.subject.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

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())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
valueO Σ1..1stringElement id
DocumentReference.subject.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Comments

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

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

Data type

Period

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ C0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.subject.display
Short description

Text alternative for the resource

Definition

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

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be 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
dateSO Σ0..1instantElement id
DocumentReference.date
Short description

When this document reference was created

Alternate names

indexed

Definition

When the document reference was created.

Comments

Referencing/indexing time is used for tracking, organizing versions and searching.

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
  • workflow: Event.occurrence[x]
  • w5: FiveWs.recorded
  • fhircomposition: Composition.date
  • rim: .availabilityTime[type="TS"]
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
authorSO Σ C0..*Reference(PCarePractitioner | PCarePractitionerRole)Element id
DocumentReference.author
Short description

Who and/or what authored the document

Definition

Identifies who is responsible for adding the information to the document.

Comments

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

Data type

Reference(PCarePractitioner | PCarePractitionerRole)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • fhircomposition: Composition.author
  • v2: TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • xds: DocumentEntry.author
  • cda: ClinicalDocument/author
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.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
DocumentReference.author.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
referenceSO Σ C0..1stringElement id
DocumentReference.author.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

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

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
DocumentReference.author.type
Short description

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

Definition

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

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

Comments

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

Data type

uri

Binding

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

ResourceType (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
identifierO Σ0..1IdentifierElement id
DocumentReference.author.identifier
Short description

Logical reference, when literal reference is not known

Definition

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

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

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

Data type

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
  • rim: .identifier
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.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
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
systemO Σ1..1uriElement id
DocumentReference.author.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

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())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
valueO Σ1..1stringElement id
DocumentReference.author.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Comments

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

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

Data type

Period

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ C0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.display
Short description

Text alternative for the resource

Definition

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

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be 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
authenticatorC0..1Reference(OrganizationCACore | PractitionerCACore | PractitionerRoleCACore)
There are no (further) constraints on this element
Element id
DocumentReference.authenticator
Short description

Who/what authenticated the document

Definition

Which person or organization authenticates that this document is valid.

Comments

Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.

Data type

Reference(OrganizationCACore | PractitionerCACore | PractitionerRoleCACore)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • w5: FiveWs.witness
  • fhircomposition: Composition.attester
  • v2: TXA-10
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • xds: DocumentEntry.legalAuthenticator
  • cda: ClinicalDocument/legalAuthenticator
custodianC0..1Reference(OrganizationCACore)
There are no (further) constraints on this element
Element id
DocumentReference.custodian
Short description

Organization which maintains the document

Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

Comments

Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

Data type

Reference(OrganizationCACore)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • fhircomposition: Composition.custodian
  • rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
relatesToΣ0..*BackboneElement
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo
Short description

Relationships to other documents

Definition

Relationships that this document has with other document references that already exist.

Comments

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

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
  • fhircomposition: Composition.relatesTo
  • rim: .outboundRelationship
  • xds: DocumentEntry Associations
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo.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
DocumentReference.relatesTo.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
DocumentReference.relatesTo.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
codeΣ1..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo.code
Short description

replaces | transforms | signs | appends

Definition

The type of relationship that this document has with anther document.

Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Data type

code

Binding

The type of relationship between documents.

DocumentRelationshipType (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Composition.relatesTo.code
  • rim: .outboundRelationship.typeCode
  • xds: DocumentEntry Associations type
targetΣ C1..1Reference(DocumentReference)
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo.target
Short description

Target of the relationship

Definition

The target document of this relationship.

Comments

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

Data type

Reference(DocumentReference)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • fhircomposition: Composition.relatesTo.target
  • rim: .target[classCode="DOC", moodCode="EVN"].id
  • xds: DocumentEntry Associations reference
descriptionΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.description
Short description

Human-readable description

Definition

Human-readable description of the source document.

Requirements

Helps humans to assess whether the document is of interest.

Comments

What the document is about, a terse summary of the document.

Data type

string

Conditions

The cardinality or value of this element may be 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: TXA-25
  • rim: .outboundRelationship[typeCode="SUBJ"].target.text
  • xds: DocumentEntry.comments
securityLabelΣ0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.securityLabel
Short description

Document security-tags

Definition

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

Requirements

Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Comments

The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.

In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

Data type

CodeableConcept

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: Composition.confidentiality, Composition.meta.security
  • v2: TXA-18
  • rim: .confidentialityCode
  • xds: DocumentEntry.confidentialityCode
  • cda: ClinicalDocument/confidentialityCode/@code
contentSO Σ1..1BackboneElementElement id
DocumentReference.content
Short description

Document referenced

Definition

The document and format referenced. There may be multiple content element repetitions, each with a different format.

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
  • fhircomposition: Bundle(Composition+*)
  • rim: document.text
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.content.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
DocumentReference.content.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
DocumentReference.content.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
attachmentSO Σ C1..1AttachmentElement id
DocumentReference.content.attachment
Short description

Where to access the document

Definition

The document or URL of the document along with critical metadata to prove content has integrity.

Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Data type

Attachment

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
  • fhircomposition: Composition.language, Composition.title, Composition.date
  • v2: TXA-3 for mime type
  • rim: document.text
  • xds: DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime
  • cda: ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.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
DocumentReference.content.attachment.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
contentTypeO Σ0..1codeBindingElement id
DocumentReference.content.attachment.contentType
Short description

Mime type of the content, with charset etc.

Definition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

Requirements

Processors of the data need to be able to know how to interpret the data.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (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())
Examples
General
text/plain; charset=UTF-8, image/png
Mappings
  • rim: n/a
  • v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
  • rim: ./mediaType, ./charset
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
languageO Σ0..1codeBindingElement id
DocumentReference.content.attachment.language
Short description

Human language of the content (BCP-47)

Definition

The human language of the content. The value can be any valid value according to BCP 47.

Requirements

Users need to be able to choose between the languages in a set of attachments.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

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())
Examples
General
en-AU
Mappings
  • rim: n/a
  • rim: ./language
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
dataO0..1base64BinaryElement id
DocumentReference.content.attachment.data
Short description

Data inline, base64ed

Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Data type

base64Binary

Conditions

The cardinality or value of this element may be 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: ED.5
  • rim: ./data
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
urlO Σ0..1urlElement id
DocumentReference.content.attachment.url
Short description

Uri where the data can be found

Definition

A location where the data can be accessed.

Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Data type

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())
Examples
General
http://www.acme.com/logo-small.png
Mappings
  • rim: n/a
  • v2: RP.1+RP.2 - if they refer to a URL (see v2.6)
  • rim: ./reference/literal
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
sizeO Σ0..1unsignedIntElement id
DocumentReference.content.attachment.size
Short description

Number of bytes of content (if url provided)

Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Data type

unsignedInt

Conditions

The cardinality or value of this element may be 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 (needs data type R3 proposal)
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
hashO Σ0..1base64BinaryElement id
DocumentReference.content.attachment.hash
Short description

Hash of the data (sha-1, base64ed)

Definition

The calculated hash of the data using SHA-1. Represented using base64.

Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Data type

base64Binary

Conditions

The cardinality or value of this element may be 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: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
titleO Σ0..1stringElement id
DocumentReference.content.attachment.title
Short description

Label to display in place of the data

Definition

A label or set of text to display in place of the data.

Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Official Corporate Logo
Mappings
  • rim: n/a
  • rim: ./title/data
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
creationΣ0..1dateTime
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.creation
Short description

Date attachment was first created

Definition

The date that the attachment was first created.

Requirements

This is often tracked as an integrity issue for use of the attachment.

Data type

dateTime

Conditions

The cardinality or value of this element may be 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 (needs data type R3 proposal)
formatΣ0..1CodingBinding
There are no (further) constraints on this element
Element id
DocumentReference.content.format
Short description

Format/content rules for the document

Definition

An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

Comments

Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.

Data type

Coding

Binding

Document Format Codes.

DocumentReferenceFormatCodeSet (preferred)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • fhircomposition: Composition.meta.profile
  • rim: document.text
  • xds: DocumentEntry.formatCode
  • cda: derived from the IHE Profile or Implementation Guide templateID
contextO Σ1..1BackboneElementElement id
DocumentReference.context
Short description

Clinical context of document

Definition

The clinical context in which the document was prepared.

Comments

These values are primarily added to help with searching for interesting/relevant documents.

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
  • rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.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
DocumentReference.context.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
DocumentReference.context.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
encounterC0..*Reference(Encounter | EpisodeOfCare)
There are no (further) constraints on this element
Element id
DocumentReference.context.encounter
Short description

Context of the document content

Definition

Describes the clinical encounter or type of care that the document content is associated with.

Comments

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

Data type

Reference(Encounter | EpisodeOfCare)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.context
  • w5: FiveWs.context
  • fhircomposition: Composition.encounter
  • rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
event0..*CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.context.event
Short description

Main clinical acts documented

Definition

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

Comments

An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

Data type

CodeableConcept

Binding

This list of codes represents the main clinical acts being documented.

ActCode (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: Composition.event.code
  • rim: .code
  • xds: DocumentEntry.eventCodeList
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.context.period
Short description

Time of service that is being documented

Definition

The time period over which the service that is described by the document was provided.

Comments

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

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

Data type

Period

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • fhircomposition: Composition.event.period
  • rim: .effectiveTime
  • xds: DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime
  • cda: ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
facilityType0..1CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.context.facilityType
Short description

Kind of facility where patient was seen

Definition

The kind of facility where the patient was seen.

Comments

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

Data type

CodeableConcept

Binding

XDS Facility Type.

FacilityTypeCodeValueSet (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: usually from a mapping to a local ValueSet
  • rim: .participation[typeCode="LOC"].role[classCode="DSDLOC"].code
  • xds: DocumentEntry.healthcareFacilityTypeCode
  • cda: usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code
practiceSetting0..1CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.context.practiceSetting
Short description

Additional details about where the content was created (e.g. clinical specialty)

Definition

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

Requirements

This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.

Comments

This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

Data type

CodeableConcept

Binding

Additional details about where the content was created (e.g. clinical specialty).

PracticeSettingCodeValueSet (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: usually from a mapping to a local ValueSet
  • rim: .participation[typeCode="LOC"].role[classCode="DSDLOC"].code
  • xds: DocumentEntry.practiceSettingCode
  • cda: usually from a mapping to a local ValueSet
sourcePatientInfoC0..1Reference(Patient)
There are no (further) constraints on this element
Element id
DocumentReference.context.sourcePatientInfo
Short description

Patient demographics from source

Definition

The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

Comments

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

Data type

Reference(Patient)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • fhircomposition: Composition.subject
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • xds: DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId
  • cda: ClinicalDocument/recordTarget/
relatedO C1..1Reference(PCareServiceRequest)Element id
DocumentReference.context.related
Short description

Related identifiers or resources

Definition

Related identifiers or resources associated with the DocumentReference.

Comments

May be identifiers or resources that caused the DocumentReference or referenced Document to be created.

Data type

Reference(PCareServiceRequest)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • fhircomposition: Composition.event.detail
  • rim: ./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]
  • xds: DocumentEntry.referenceIdList
  • cda: ClinicalDocument/relatedDocument
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.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
DocumentReference.context.related.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
referenceO Σ C0..1stringElement id
DocumentReference.context.related.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

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

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
DocumentReference.context.related.type
Short description

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

Definition

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

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

Comments

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

Data type

uri

Binding

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

ResourceType (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
identifierO Σ0..1IdentifierElement id
DocumentReference.context.related.identifier
Short description

Logical reference, when literal reference is not known

Definition

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

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

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

Data type

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
  • rim: .identifier
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.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
useO Σ ?!1..1codeBindingElement id
DocumentReference.context.related.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
systemO Σ1..1uriElement id
DocumentReference.context.related.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

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())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
valueO Σ1..1stringElement id
DocumentReference.context.related.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
NameCodeDocumentationActor
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Comments

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

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

Data type

Period

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ C0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.display
Short description

Text alternative for the resource

Definition

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

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be 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
PCareDocumentReference (DocumentReference)CDocumentReferenceCACore
There are no (further) constraints on this element
Element id
DocumentReference
Short description

A reference to a document

Definition

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.

Comments

Usually, this is used for documents other than those defined by FHIR.

Data type

DocumentReferenceCACore

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
  • fhircomposition: when describing a Composition
  • rim: Document[classCode="DOC" and moodCode="EVN"]
  • cda: when describing a CDA
idΣ0..1id
There are no (further) constraints on this element
Element id
DocumentReference.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
metaO Σ0..1Meta
There are no (further) constraints on this element
Element id
DocumentReference.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
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.meta.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
DocumentReference.meta.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
versionIdΣ0..1id
There are no (further) constraints on this element
Element id
DocumentReference.meta.versionId
Short description

Version specific identifier

Definition

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

Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Data type

id

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
lastUpdatedΣ0..1instant
There are no (further) constraints on this element
Element id
DocumentReference.meta.lastUpdated
Short description

When the resource version last changed

Definition

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

Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Data type

instant

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
sourceΣ0..1uri
There are no (further) constraints on this element
Element id
DocumentReference.meta.source
Short description

Identifies where the resource comes from

Definition

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

Comments

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

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

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
profileO Σ0..*canonical(StructureDefinition)
There are no (further) constraints on this element
Element id
DocumentReference.meta.profile
Short description

Profiles this resource claims to conform to

Definition

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

Comments

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

Data type

canonical(StructureDefinition)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
securityΣ0..*CodingBinding
There are no (further) constraints on this element
Element id
DocumentReference.meta.security
Short description

Security Labels applied to this resource

Definition

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

Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
tagΣ0..*Coding
There are no (further) constraints on this element
Element id
DocumentReference.meta.tag
Short description

Tags applied to this resource

Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Data type

Coding

Binding

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

CommonTags (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
DocumentReference.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
DocumentReference.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
text0..1Narrative
There are no (further) constraints on this element
Element id
DocumentReference.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

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

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
DocumentReference.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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

Comments

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

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
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 resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

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
DocumentReference.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

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

Requirements

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

Comments

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
masterIdentifierΣ0..1Identifier
There are no (further) constraints on this element
Element id
DocumentReference.masterIdentifier
Short description

Master Version Specific Identifier

Definition

Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.

Requirements

The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).

Comments

CDA Document Id extension and root.

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
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • fhircomposition: Composition.identifier
  • v2: TXA-12
  • rim: .id
  • xds: DocumentEntry.uniqueId
  • cda: ClinicalDocument/id
identifierSO Σ0..*Identifier
There are no (further) constraints on this element
Element id
DocumentReference.identifier
Short description

Other identifiers for the document

Definition

Other identifiers associated with the document, including version independent identifiers.

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
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • v2: TXA-16?
  • rim: .id / .setId
  • xds: DocumentEntry.entryUUID
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
DocumentReference.identifier.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
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: CX.5
  • rim: Role.code or implied by context
systemSO Σ1..1uri
There are no (further) constraints on this element
Element id
DocumentReference.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

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())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • rim: n/a
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

valueSO Σ1..1string
There are no (further) constraints on this element
Element id
DocumentReference.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • rim: n/a
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

periodΣ C0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Comments

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

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

Data type

Period

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ C0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
statusO Σ ?!1..1codeBindingPattern
There are no (further) constraints on this element
Element id
DocumentReference.status
Short description

current | superseded | entered-in-error

Definition

The status of this document reference.

Comments

This is the status of the DocumentReference object, which might be independent from the docStatus element.

This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.

Data type

code

Binding

The status of the document reference.

DocumentReferenceStatus (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())
Pattern
current
Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • v2: TXA-19
  • rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
  • xds: DocumentEntry.availabilityStatus
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
docStatusΣ0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.docStatus
Short description

preliminary | final | amended | entered-in-error

Definition

The status of the underlying document.

Comments

The document that is pointed to might be in various lifecycle states.

Data type

code

Binding

Status of the underlying document.

CompositionStatus (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • fhircomposition: Composition.status
  • v2: TXA-17
  • rim: .statusCode
typeSO Σ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.type
Short description

Kind of document (LOINC if possible)

Definition

Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.

Comments

Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

Data type

CodeableConcept

Binding

Precise type of clinical document.

DocumentTypeValueSet (preferred)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.code
  • w5: FiveWs.class
  • fhircomposition: Composition.type
  • v2: TXA-2
  • rim: ./code
  • xds: DocumentEntry.type
  • cda: ClinicalDocument/code/@code The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted.
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

categoryΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.category
Short description

Categorization of document

Alternate names

claxs

Definition

A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.

Comments

Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

Data type

CodeableConcept

Binding

High-level kind of a clinical document at a macro level.

DocumentClassValueSet (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • fhircomposition: Composition.class
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • xds: DocumentEntry.class
  • cda: Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code
subjectSO Σ C0..1Reference(PCarePatient)
There are no (further) constraints on this element
Element id
DocumentReference.subject
Short description

Who/what is the subject of the document

Definition

Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).

Comments

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

Data type

Reference(PCarePatient)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • fhircomposition: Composition.subject
  • v2: PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • xds: DocumentEntry.patientId
  • cda: ClinicalDocument/recordTarget/
  • w5: FiveWs.subject
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

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

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
referenceO Σ C0..1string
There are no (further) constraints on this element
Element id
DocumentReference.subject.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

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

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
DocumentReference.subject.type
Short description

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

Definition

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

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

Comments

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

Data type

uri

Binding

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

ResourceType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
identifierO Σ0..1Identifier
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier
Short description

Logical reference, when literal reference is not known

Definition

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

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

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

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

Identifier Type Codes (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
systemO Σ1..1uri
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
valueO Σ1..1string
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
periodΣ0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.subject.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.subject.display
Short description

Text alternative for the resource

Definition

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

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
dateSO Σ0..1instant
There are no (further) constraints on this element
Element id
DocumentReference.date
Short description

When this document reference was created

Alternate names

indexed

Definition

When the document reference was created.

Comments

Referencing/indexing time is used for tracking, organizing versions and searching.

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
  • workflow: Event.occurrence[x]
  • w5: FiveWs.recorded
  • fhircomposition: Composition.date
  • rim: .availabilityTime[type="TS"]
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

authorSO Σ C0..*Reference(PCarePractitioner | PCarePractitionerRole)
There are no (further) constraints on this element
Element id
DocumentReference.author
Short description

Who and/or what authored the document

Definition

Identifies who is responsible for adding the information to the document.

Comments

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

Data type

Reference(PCarePractitioner | PCarePractitionerRole)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • fhircomposition: Composition.author
  • v2: TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • xds: DocumentEntry.author
  • cda: ClinicalDocument/author
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.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
DocumentReference.author.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
referenceSO Σ C0..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

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

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
DocumentReference.author.type
Short description

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

Definition

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

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

Comments

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

Data type

uri

Binding

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

ResourceType (extensible)

Conditions

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

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

Logical reference, when literal reference is not known

Definition

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

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

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

Data type

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
  • rim: .identifier
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

Identifier Type Codes (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
systemO Σ1..1uri
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
valueO Σ1..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
periodΣ0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.author.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.author.display
Short description

Text alternative for the resource

Definition

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

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Conditions

The cardinality or value of this element may be 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
authenticatorC0..1Reference(OrganizationCACore | PractitionerCACore | PractitionerRoleCACore)
There are no (further) constraints on this element
Element id
DocumentReference.authenticator
Short description

Who/what authenticated the document

Definition

Which person or organization authenticates that this document is valid.

Comments

Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.

Data type

Reference(OrganizationCACore | PractitionerCACore | PractitionerRoleCACore)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • w5: FiveWs.witness
  • fhircomposition: Composition.attester
  • v2: TXA-10
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • xds: DocumentEntry.legalAuthenticator
  • cda: ClinicalDocument/legalAuthenticator
custodianC0..1Reference(OrganizationCACore)
There are no (further) constraints on this element
Element id
DocumentReference.custodian
Short description

Organization which maintains the document

Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

Comments

Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.

Data type

Reference(OrganizationCACore)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • fhircomposition: Composition.custodian
  • rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
relatesToΣ0..*BackboneElement
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo
Short description

Relationships to other documents

Definition

Relationships that this document has with other document references that already exist.

Comments

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

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
  • fhircomposition: Composition.relatesTo
  • rim: .outboundRelationship
  • xds: DocumentEntry Associations
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo.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
DocumentReference.relatesTo.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
DocumentReference.relatesTo.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
codeΣ1..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo.code
Short description

replaces | transforms | signs | appends

Definition

The type of relationship that this document has with anther document.

Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Data type

code

Binding

The type of relationship between documents.

DocumentRelationshipType (required)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • fhircomposition: Composition.relatesTo.code
  • rim: .outboundRelationship.typeCode
  • xds: DocumentEntry Associations type
targetΣ C1..1Reference(DocumentReference)
There are no (further) constraints on this element
Element id
DocumentReference.relatesTo.target
Short description

Target of the relationship

Definition

The target document of this relationship.

Comments

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

Data type

Reference(DocumentReference)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • fhircomposition: Composition.relatesTo.target
  • rim: .target[classCode="DOC", moodCode="EVN"].id
  • xds: DocumentEntry Associations reference
descriptionΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.description
Short description

Human-readable description

Definition

Human-readable description of the source document.

Requirements

Helps humans to assess whether the document is of interest.

Comments

What the document is about, a terse summary of the document.

Data type

string

Conditions

The cardinality or value of this element may be 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: TXA-25
  • rim: .outboundRelationship[typeCode="SUBJ"].target.text
  • xds: DocumentEntry.comments
securityLabelΣ0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.securityLabel
Short description

Document security-tags

Definition

A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.

Requirements

Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Comments

The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.

In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.

Data type

CodeableConcept

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: Composition.confidentiality, Composition.meta.security
  • v2: TXA-18
  • rim: .confidentialityCode
  • xds: DocumentEntry.confidentialityCode
  • cda: ClinicalDocument/confidentialityCode/@code
contentSO Σ1..1BackboneElement
There are no (further) constraints on this element
Element id
DocumentReference.content
Short description

Document referenced

Definition

The document and format referenced. There may be multiple content element repetitions, each with a different format.

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
  • fhircomposition: Bundle(Composition+*)
  • rim: document.text
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.content.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
DocumentReference.content.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
DocumentReference.content.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
attachmentSO Σ C1..1Attachment
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment
Short description

Where to access the document

Definition

The document or URL of the document along with critical metadata to prove content has integrity.

Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Data type

Attachment

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
  • fhircomposition: Composition.language, Composition.title, Composition.date
  • v2: TXA-3 for mime type
  • rim: document.text
  • xds: DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime
  • cda: ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date
Obligations
CodeActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-sourceNameDocumentation
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
SHALL:populate
SHALL:persist
SHALL:no-error		http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0pcare

P-Care server population, persistence, and acceptance requirements for this element.

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

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
contentTypeO Σ0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.contentType
Short description

Mime type of the content, with charset etc.

Definition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

Requirements

Processors of the data need to be able to know how to interpret the data.

Data type

code

Binding

The mime type of an attachment. Any valid mime type is allowed.

Mime Types (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
text/plain; charset=UTF-8, image/png
Mappings
  • v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
  • rim: ./mediaType, ./charset
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
languageO Σ0..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.language
Short description

Human language of the content (BCP-47)

Definition

The human language of the content. The value can be any valid value according to BCP 47.

Requirements

Users need to be able to choose between the languages in a set of attachments.

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
MaxValueSetAllLanguages
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
en-AU
Mappings
  • rim: ./language
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
dataO0..1base64Binary
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.data
Short description

Data inline, base64ed

Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Data type

base64Binary

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: ED.5
  • rim: ./data
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
urlO Σ0..1url
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.url
Short description

Uri where the data can be found

Definition

A location where the data can be accessed.

Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Data type

url

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
http://www.acme.com/logo-small.png
Mappings
  • v2: RP.1+RP.2 - if they refer to a URL (see v2.6)
  • rim: ./reference/literal
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
sizeO Σ0..1unsignedInt
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.size
Short description

Number of bytes of content (if url provided)

Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Data type

unsignedInt

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A (needs data type R3 proposal)
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
hashO Σ0..1base64Binary
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.hash
Short description

Hash of the data (sha-1, base64ed)

Definition

The calculated hash of the data using SHA-1. Represented using base64.

Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Data type

base64Binary

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
titleO Σ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.title
Short description

Label to display in place of the data

Definition

A label or set of text to display in place of the data.

Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Official Corporate Logo
Mappings
  • rim: ./title/data
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
creationΣ0..1dateTime
There are no (further) constraints on this element
Element id
DocumentReference.content.attachment.creation
Short description

Date attachment was first created

Definition

The date that the attachment was first created.

Requirements

This is often tracked as an integrity issue for use of the attachment.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A (needs data type R3 proposal)
formatΣ0..1CodingBinding
There are no (further) constraints on this element
Element id
DocumentReference.content.format
Short description

Format/content rules for the document

Definition

An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

Comments

Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.

Data type

Coding

Binding

Document Format Codes.

DocumentReferenceFormatCodeSet (preferred)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • fhircomposition: Composition.meta.profile
  • rim: document.text
  • xds: DocumentEntry.formatCode
  • cda: derived from the IHE Profile or Implementation Guide templateID
contextO Σ1..1BackboneElement
There are no (further) constraints on this element
Element id
DocumentReference.context
Short description

Clinical context of document

Definition

The clinical context in which the document was prepared.

Comments

These values are primarily added to help with searching for interesting/relevant documents.

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
  • rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.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
DocumentReference.context.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
DocumentReference.context.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
encounterC0..*Reference(Encounter | EpisodeOfCare)
There are no (further) constraints on this element
Element id
DocumentReference.context.encounter
Short description

Context of the document content

Definition

Describes the clinical encounter or type of care that the document content is associated with.

Comments

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

Data type

Reference(Encounter | EpisodeOfCare)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.context
  • w5: FiveWs.context
  • fhircomposition: Composition.encounter
  • rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
event0..*CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.context.event
Short description

Main clinical acts documented

Definition

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

Comments

An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.

Data type

CodeableConcept

Binding

This list of codes represents the main clinical acts being documented.

ActCode (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: Composition.event.code
  • rim: .code
  • xds: DocumentEntry.eventCodeList
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.context.period
Short description

Time of service that is being documented

Definition

The time period over which the service that is described by the document was provided.

Comments

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

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

Data type

Period

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • fhircomposition: Composition.event.period
  • rim: .effectiveTime
  • xds: DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime
  • cda: ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
facilityType0..1CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.context.facilityType
Short description

Kind of facility where patient was seen

Definition

The kind of facility where the patient was seen.

Comments

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

Data type

CodeableConcept

Binding

XDS Facility Type.

FacilityTypeCodeValueSet (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: usually from a mapping to a local ValueSet
  • rim: .participation[typeCode="LOC"].role[classCode="DSDLOC"].code
  • xds: DocumentEntry.healthcareFacilityTypeCode
  • cda: usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code
practiceSetting0..1CodeableConcept
There are no (further) constraints on this element
Element id
DocumentReference.context.practiceSetting
Short description

Additional details about where the content was created (e.g. clinical specialty)

Definition

This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

Requirements

This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.

Comments

This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.

Data type

CodeableConcept

Binding

Additional details about where the content was created (e.g. clinical specialty).

PracticeSettingCodeValueSet (example)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • fhircomposition: usually from a mapping to a local ValueSet
  • rim: .participation[typeCode="LOC"].role[classCode="DSDLOC"].code
  • xds: DocumentEntry.practiceSettingCode
  • cda: usually from a mapping to a local ValueSet
sourcePatientInfoC0..1Reference(Patient)
There are no (further) constraints on this element
Element id
DocumentReference.context.sourcePatientInfo
Short description

Patient demographics from source

Definition

The Patient Information as known when the document was published. May be a reference to a version specific, or contained.

Comments

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

Data type

Reference(Patient)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • fhircomposition: Composition.subject
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • xds: DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId
  • cda: ClinicalDocument/recordTarget/
relatedO C1..1Reference(PCareServiceRequest)
There are no (further) constraints on this element
Element id
DocumentReference.context.related
Short description

Related identifiers or resources

Definition

Related identifiers or resources associated with the DocumentReference.

Comments

May be identifiers or resources that caused the DocumentReference or referenced Document to be created.

Data type

Reference(PCareServiceRequest)

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • fhircomposition: Composition.event.detail
  • rim: ./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]
  • xds: DocumentEntry.referenceIdList
  • cda: ClinicalDocument/relatedDocument
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.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
DocumentReference.context.related.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

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
referenceO Σ C0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.reference
Short description

Literal reference, Relative, internal or absolute URL

Definition

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

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Data type

string

Conditions

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

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id
DocumentReference.context.related.type
Short description

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

Definition

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

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

Comments

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

Data type

uri

Binding

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

ResourceType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
identifierO Σ0..1Identifier
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier
Short description

Logical reference, when literal reference is not known

Definition

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

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

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

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
id0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

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

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
useO Σ ?!1..1codeBinding
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.use
Short description

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

Definition

The purpose of this identifier.

Requirements

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

Comments

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

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.type
Short description

Description of identifier

Definition

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

Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

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

Identifier Type Codes (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
systemO Σ1..1uri
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.system
Short description

The namespace for the identifier value

Definition

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

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
http://www.acme.com/identifiers/patient
Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
valueO Σ1..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.value
Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
123456
Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
Obligations
NameCodeDocumentationActorHttp://hl7.org/fhir/tools/StructureDefinition/snapshot-source
pcareSHALL:populate
SHALL:persist
SHALL:no-error

P-Care server population, persistence, and acceptance requirements for this element.

http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverhttp://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0
periodΣ0..1Period
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.period
Short description

Time period when id is/was valid for use

Definition

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

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ0..1Reference(Organization)
There are no (further) constraints on this element
Element id
DocumentReference.context.related.identifier.assigner
Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id
DocumentReference.context.related.display
Short description

Text alternative for the resource

Definition

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

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="document-reference" />
<text>
<status value="extensions" />
--- We have skipped the narrative for better readability of the resource ---
</text>
<url value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference" />
<version value="0.1.0" />
<name value="PCareDocumentReference" />
<title value="P-Care Document Reference" />
<status value="draft" />
<date value="2026-10-19T22:14:59+00:00" />
<publisher value="Infoway" />
<description value="A reference to a document of any kind for any purpose." />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="DocumentReference" />
<baseDefinition value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core" />
<derivation value="constraint" />
<snapshot>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="1.1.0" />
</extension>
<element id="DocumentReference">
<path value="DocumentReference" />
<short value="A reference to a document" />
<definition value="A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text." />
<comment value="Usually, this is used for documents other than those defined by FHIR." />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference" />
<min value="0" />
<max value="*" />
</base>
<constraint>
<key value="dom-2" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
<expression value="contained.contained.empty()" />
<xpath value="not(parent::f:contained and f:contained)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-4" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-3" />
<severity value="error" />
<human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource" />
<expression value="contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()" />
<xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." />
</extension>
<key value="dom-6" />
<severity value="warning" />
<human value="A resource should have narrative for robust management" />
<expression value="text.`div`.exists()" />
<xpath value="exists(f:text/h:div)" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<constraint>
<key value="dom-5" />
<severity value="error" />
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
<expression value="contained.meta.security.empty()" />
<xpath value="not(exists(f:contained/*/f:meta/f:security))" />
<source value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
</constraint>
<mapping>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="when describing a Composition" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Document[classCode="DOC" and moodCode="EVN"]" />
</mapping>
<mapping>
<identity value="cda" />
<map value="when describing a CDA" />
</mapping>
</element>
<element id="DocumentReference.id">
<path value="DocumentReference.id" />
<short value="Logical id of this artifact" />
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="id" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.meta">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.meta" />
<short value="Metadata about the resource" />
<definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.meta" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Meta" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.meta.id">
<path value="DocumentReference.meta.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.meta.extension">
<path value="DocumentReference.meta.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.meta.versionId">
<path value="DocumentReference.meta.versionId" />
<short value="Version specific identifier" />
<definition value="The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted." />
<comment value="The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes." />
<min value="0" />
<max value="1" />
<base>
<path value="Meta.versionId" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="id" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="DocumentReference.meta.lastUpdated">
<path value="DocumentReference.meta.lastUpdated" />
<short value="When the resource version last changed" />
<definition value="When the resource last changed - e.g. when the version changed." />
<comment value="This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction." />
<min value="0" />
<max value="1" />
<base>
<path value="Meta.lastUpdated" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="instant" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="DocumentReference.meta.source">
<path value="DocumentReference.meta.source" />
<short value="Identifies where the resource comes from" />
<definition value="A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc." />
<comment value="In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL." />
<min value="0" />
<max value="1" />
<base>
<path value="Meta.source" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="DocumentReference.meta.profile">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.meta.profile" />
<short value="Profiles this resource claims to conform to" />
<definition value="A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url)." />
<comment value="Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to." />
<min value="0" />
<max value="*" />
<base>
<path value="Meta.profile" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="canonical" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/StructureDefinition|4.0.1" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
</element>
<element id="DocumentReference.meta.security">
<path value="DocumentReference.meta.security" />
<short value="Security Labels applied to this resource" />
<definition value="Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure." />
<comment value="The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored." />
<min value="0" />
<max value="*" />
<base>
<path value="Meta.security" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Coding" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="SecurityLabels" />
</extension>
<strength value="extensible" />
<description value="Security Labels from the Healthcare Privacy and Security Classification System." />
<valueSet value="http://hl7.org/fhir/ValueSet/security-labels|4.0.1" />
</binding>
</element>
<element id="DocumentReference.meta.tag">
<path value="DocumentReference.meta.tag" />
<short value="Tags applied to this resource" />
<definition value="Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource." />
<comment value="The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored." />
<min value="0" />
<max value="*" />
<base>
<path value="Meta.tag" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Coding" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Tags" />
</extension>
<strength value="example" />
<description value="Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"." />
<valueSet value="http://hl7.org/fhir/ValueSet/common-tags|4.0.1" />
</binding>
</element>
<element id="DocumentReference.implicitRules">
<path value="DocumentReference.implicitRules" />
<short value="A set of rules under which this content was created" />
<definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." />
<comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.implicitRules" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.language">
<path value="DocumentReference.language" />
<short value="Language of the resource content" />
<definition value="The base language in which the resource is written." />
<comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." />
<min value="0" />
<max value="1" />
<base>
<path value="Resource.language" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language" />
</extension>
<strength value="preferred" />
<description value="A human language." />
<valueSet value="http://hl7.org/fhir/ValueSet/languages" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.text">
<path value="DocumentReference.text" />
<short value="Text summary of the resource, for human interpretation" />
<definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." />
<comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." />
<alias value="narrative" />
<alias value="html" />
<alias value="xhtml" />
<alias value="display" />
<min value="0" />
<max value="1" />
<base>
<path value="DomainResource.text" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Narrative" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Act.text?" />
</mapping>
</element>
<element id="DocumentReference.contained">
<path value="DocumentReference.contained" />
<short value="Contained, inline Resources" />
<definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." />
<comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." />
<alias value="inline resources" />
<alias value="anonymous resources" />
<alias value="contained resources" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.contained" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Resource" />
</type>
<mapping>
<identity value="rim" />
<map value="Entity. Role, or Act" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.extension">
<path value="DocumentReference.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.modifierExtension">
<path value="DocumentReference.modifierExtension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Extensions that cannot be ignored" />
<definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="DomainResource.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.masterIdentifier">
<path value="DocumentReference.masterIdentifier" />
<short value="Master Version Specific Identifier" />
<definition value="Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document." />
<comment value="CDA Document Id extension and root." />
<requirements value="The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.)." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.masterIdentifier" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Identifier" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="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]" />
</mapping>
<mapping>
<identity value="servd" />
<map value="Identifier" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.identifier" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.identifier" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.identifier" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-12" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".id" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.uniqueId" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/id" />
</mapping>
</element>
<element id="DocumentReference.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.identifier" />
<short value="Other identifiers for the document" />
<definition value="Other identifiers associated with the document, including version independent identifiers." />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference.identifier" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Identifier" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="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]" />
</mapping>
<mapping>
<identity value="servd" />
<map value="Identifier" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.identifier" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.identifier" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-16?" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".id / .setId" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.entryUUID" />
</mapping>
</element>
<element id="DocumentReference.identifier.id">
<path value="DocumentReference.identifier.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.identifier.extension">
<path value="DocumentReference.identifier.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.identifier.use">
<path value="DocumentReference.identifier.use" />
<short value="usual | official | temp | secondary | old (If known)" />
<definition value="The purpose of this identifier." />
<comment value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary." />
<requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.use" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one." />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierUse" />
</extension>
<strength value="required" />
<description value="Identifies the purpose for this identifier, if known ." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.identifier.type">
<path value="DocumentReference.identifier.type" />
<short value="Description of identifier" />
<definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." />
<comment value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type." />
<requirements value="Allows users to make use of identifiers when the identifier system is not known." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierType" />
</extension>
<strength value="extensible" />
<description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-type" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX.5" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.identifier.system" />
<short value="The namespace for the identifier value" />
<definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique." />
<comment value="Identifier.system is always case sensitive." />
<requirements value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.system" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<example>
<label value="General" />
<valueUri value="http://www.acme.com/identifiers/patient" />
</example>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX.4 / EI-2-4" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.root or Role.id.root" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierType" />
</mapping>
</element>
<element id="DocumentReference.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.identifier.value" />
<short value="The value that is unique" />
<definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system." />
<comment value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.value" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<example>
<label value="General" />
<valueString value="123456" />
</example>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX.1 / EI.1" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./Value" />
</mapping>
</element>
<element id="DocumentReference.identifier.period">
<path value="DocumentReference.identifier.period" />
<short value="Time period when id is/was valid for use" />
<definition value="Time period during which identifier is/was valid for use." />
<comment value="A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration)." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.period" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Period" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="per-1" />
<severity value="error" />
<human value="If present, start SHALL have a lower value than end" />
<expression value="start.hasValue().not() or end.hasValue().not() or (start <= end)" />
<xpath value="not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))" />
<source value="http://hl7.org/fhir/StructureDefinition/Period" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="DR" />
</mapping>
<mapping>
<identity value="rim" />
<map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX.7 + CX.8" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.effectiveTime or implied by context" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./StartDate and ./EndDate" />
</mapping>
</element>
<element id="DocumentReference.identifier.assigner">
<path value="DocumentReference.identifier.assigner" />
<short value="Organization that issued id (may be just text)" />
<definition value="Organization that issued/manages the identifier." />
<comment value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.assigner" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX.4 / (CX.4,CX.9,CX.10)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierIssuingAuthority" />
</mapping>
</element>
<element id="DocumentReference.status">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.status" />
<short value="current | superseded | entered-in-error" />
<definition value="The status of this document reference." />
<comment value="This is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid." />
<min value="1" />
<max value="1" />
<base>
<path value="DocumentReference.status" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<patternCode value="current" />
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentReferenceStatus" />
</extension>
<strength value="required" />
<description value="The status of the document reference." />
<valueSet value="http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.status" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.status" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-19" />
</mapping>
<mapping>
<identity value="rim" />
<map value="interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.availabilityStatus" />
</mapping>
</element>
<element id="DocumentReference.docStatus">
<path value="DocumentReference.docStatus" />
<short value="preliminary | final | amended | entered-in-error" />
<definition value="The status of the underlying document." />
<comment value="The document that is pointed to might be in various lifecycle states." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.docStatus" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="ReferredDocumentStatus" />
</extension>
<strength value="required" />
<description value="Status of the underlying document." />
<valueSet value="http://hl7.org/fhir/ValueSet/composition-status|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.status" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.status" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-17" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".statusCode" />
</mapping>
</element>
<element id="DocumentReference.type">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.type" />
<short value="Kind of document (LOINC if possible)" />
<definition value="Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced." />
<comment value="Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentC80Type" />
</extension>
<strength value="preferred" />
<description value="Precise type of clinical document." />
<valueSet value="http://hl7.org/fhir/ValueSet/c80-doc-typecodes" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.code" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.class" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.type" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-2" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./code" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.type" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/code/@code \n\nThe typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted." />
</mapping>
</element>
<element id="DocumentReference.category">
<path value="DocumentReference.category" />
<short value="Categorization of document" />
<definition value="A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type." />
<comment value="Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching." />
<alias value="claxs" />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference.category" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentC80Class" />
</extension>
<strength value="example" />
<description value="High-level kind of a clinical document at a macro level." />
<valueSet value="http://hl7.org/fhir/ValueSet/document-classcodes" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.class" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.class" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.class" />
</mapping>
<mapping>
<identity value="cda" />
<map value="Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code" />
</mapping>
</element>
<element id="DocumentReference.subject">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.subject" />
<short value="Who/what is the subject of the document" />
<definition value="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.subject" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/patient" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.subject" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.subject[x]" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.subject" />
</mapping>
<mapping>
<identity value="v2" />
<map value="PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode="SBJ"].role[typeCode="PAT"]" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.patientId" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/recordTarget/" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.subject" />
</mapping>
</element>
<element id="DocumentReference.subject.id">
<path value="DocumentReference.subject.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.subject.extension">
<path value="DocumentReference.subject.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.subject.reference">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.subject.reference" />
<short value="Literal reference, Relative, internal or absolute URL" />
<definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources." />
<comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.reference" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ref-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.subject.type">
<path value="DocumentReference.subject.type" />
<short value="Type the reference refers to (e.g. "Patient")" />
<definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)." />
<comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FHIRResourceTypeExt" />
</extension>
<strength value="extensible" />
<description value="Aa resource (or, for logical models, the URI of the logical model)." />
<valueSet value="http://hl7.org/fhir/ValueSet/resource-types|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.subject.identifier" />
<short value="Logical reference, when literal reference is not known" />
<definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." />
<comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.identifier" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Identifier" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value=".identifier" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.id">
<path value="DocumentReference.subject.identifier.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.extension">
<path value="DocumentReference.subject.identifier.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.use">
<path value="DocumentReference.subject.identifier.use" />
<short value="usual | official | temp | secondary | old (If known)" />
<definition value="The purpose of this identifier." />
<comment value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary." />
<requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.use" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one." />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierUse" />
</extension>
<strength value="required" />
<description value="Identifies the purpose for this identifier, if known ." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.type">
<path value="DocumentReference.subject.identifier.type" />
<short value="Description of identifier" />
<definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." />
<comment value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type." />
<requirements value="Allows users to make use of identifiers when the identifier system is not known." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierType" />
</extension>
<strength value="extensible" />
<description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-type|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="CX.5" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.subject.identifier.system" />
<short value="The namespace for the identifier value" />
<definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique." />
<comment value="Identifier.system is always case sensitive." />
<requirements value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.system" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<example>
<label value="General" />
<valueUri value="http://www.acme.com/identifiers/patient" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.4 / EI-2-4" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.root or Role.id.root" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierType" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.subject.identifier.value" />
<short value="The value that is unique" />
<definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system." />
<comment value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.value" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<example>
<label value="General" />
<valueString value="123456" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.1 / EI.1" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./Value" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.period">
<path value="DocumentReference.subject.identifier.period" />
<short value="Time period when id is/was valid for use" />
<definition value="Time period during which identifier is/was valid for use." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.period" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Period" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.7 + CX.8" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.effectiveTime or implied by context" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./StartDate and ./EndDate" />
</mapping>
</element>
<element id="DocumentReference.subject.identifier.assigner">
<path value="DocumentReference.subject.identifier.assigner" />
<short value="Organization that issued id (may be just text)" />
<definition value="Organization that issued/manages the identifier." />
<comment value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.assigner" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization|4.0.1" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.4 / (CX.4,CX.9,CX.10)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierIssuingAuthority" />
</mapping>
</element>
<element id="DocumentReference.subject.display">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<path value="DocumentReference.subject.display" />
<short value="Text alternative for the resource" />
<definition value="Plain text narrative that identifies the resource in addition to the resource reference." />
<comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.display" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.date">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.date" />
<short value="When this document reference was created" />
<definition value="When the document reference was created." />
<comment value="Referencing/indexing time is used for tracking, organizing versions and searching." />
<alias value="indexed" />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.date" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="instant" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.occurrence[x]" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.recorded" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.date" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".availabilityTime[type="TS"]" />
</mapping>
</element>
<element id="DocumentReference.author">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.author" />
<short value="Who and/or what authored the document" />
<definition value="Identifies who is responsible for adding the information to the document." />
<comment value="Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant)." />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference.author" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner-role" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.performer.actor" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.author" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode="AUT"].role[classCode="ASSIGNED"]" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.author" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/author" />
</mapping>
</element>
<element id="DocumentReference.author.id">
<path value="DocumentReference.author.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.author.extension">
<path value="DocumentReference.author.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.author.reference">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.author.reference" />
<short value="Literal reference, Relative, internal or absolute URL" />
<definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources." />
<comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.reference" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ele-1" />
<condition value="ref-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.author.type">
<path value="DocumentReference.author.type" />
<short value="Type the reference refers to (e.g. "Patient")" />
<definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)." />
<comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FHIRResourceTypeExt" />
</extension>
<strength value="extensible" />
<description value="Aa resource (or, for logical models, the URI of the logical model)." />
<valueSet value="http://hl7.org/fhir/ValueSet/resource-types" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.author.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.author.identifier" />
<short value="Logical reference, when literal reference is not known" />
<definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." />
<comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.identifier" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Identifier" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CX / EI (occasionally, more often EI maps to a resource id or a URL)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="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]" />
</mapping>
<mapping>
<identity value="servd" />
<map value="Identifier" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".identifier" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.id">
<path value="DocumentReference.author.identifier.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.extension">
<path value="DocumentReference.author.identifier.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.use">
<path value="DocumentReference.author.identifier.use" />
<short value="usual | official | temp | secondary | old (If known)" />
<definition value="The purpose of this identifier." />
<comment value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary." />
<requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.use" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one." />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierUse" />
</extension>
<strength value="required" />
<description value="Identifies the purpose for this identifier, if known ." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.type">
<path value="DocumentReference.author.identifier.type" />
<short value="Description of identifier" />
<definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." />
<comment value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type." />
<requirements value="Allows users to make use of identifiers when the identifier system is not known." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierType" />
</extension>
<strength value="extensible" />
<description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-type|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="CX.5" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.author.identifier.system" />
<short value="The namespace for the identifier value" />
<definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique." />
<comment value="Identifier.system is always case sensitive." />
<requirements value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.system" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<example>
<label value="General" />
<valueUri value="http://www.acme.com/identifiers/patient" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.4 / EI-2-4" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.root or Role.id.root" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierType" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.author.identifier.value" />
<short value="The value that is unique" />
<definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system." />
<comment value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.value" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<example>
<label value="General" />
<valueString value="123456" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.1 / EI.1" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./Value" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.period">
<path value="DocumentReference.author.identifier.period" />
<short value="Time period when id is/was valid for use" />
<definition value="Time period during which identifier is/was valid for use." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.period" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Period" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.7 + CX.8" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.effectiveTime or implied by context" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./StartDate and ./EndDate" />
</mapping>
</element>
<element id="DocumentReference.author.identifier.assigner">
<path value="DocumentReference.author.identifier.assigner" />
<short value="Organization that issued id (may be just text)" />
<definition value="Organization that issued/manages the identifier." />
<comment value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.assigner" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization|4.0.1" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.4 / (CX.4,CX.9,CX.10)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierIssuingAuthority" />
</mapping>
</element>
<element id="DocumentReference.author.display">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<path value="DocumentReference.author.display" />
<short value="Text alternative for the resource" />
<definition value="Plain text narrative that identifies the resource in addition to the resource reference." />
<comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.display" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.authenticator">
<path value="DocumentReference.authenticator" />
<short value="Who/what authenticated the document" />
<definition value="Which person or organization authenticates that this document is valid." />
<comment value="Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.authenticator" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.performer.actor" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.witness" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.attester" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-10" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.legalAuthenticator" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/legalAuthenticator" />
</mapping>
</element>
<element id="DocumentReference.custodian">
<path value="DocumentReference.custodian" />
<short value="Organization which maintains the document" />
<definition value="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document." />
<comment value="Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.custodian" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.performer.actor" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.custodian" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]" />
</mapping>
</element>
<element id="DocumentReference.relatesTo">
<path value="DocumentReference.relatesTo" />
<short value="Relationships to other documents" />
<definition value="Relationships that this document has with other document references that already exist." />
<comment value="This element is labeled as a modifier because documents that append to other documents are incomplete on their own." />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference.relatesTo" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="BackboneElement" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.relatesTo" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".outboundRelationship" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry Associations" />
</mapping>
</element>
<element id="DocumentReference.relatesTo.id">
<path value="DocumentReference.relatesTo.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.relatesTo.extension">
<path value="DocumentReference.relatesTo.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.relatesTo.modifierExtension">
<path value="DocumentReference.relatesTo.modifierExtension" />
<short value="Extensions that cannot be ignored even if unrecognized" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<alias value="modifiers" />
<min value="0" />
<max value="*" />
<base>
<path value="BackboneElement.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.relatesTo.code">
<path value="DocumentReference.relatesTo.code" />
<short value="replaces | transforms | signs | appends" />
<definition value="The type of relationship that this document has with anther document." />
<comment value="If this document appends another document, then the document cannot be fully understood without also accessing the referenced document." />
<min value="1" />
<max value="1" />
<base>
<path value="DocumentReference.relatesTo.code" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentRelationshipType" />
</extension>
<strength value="required" />
<description value="The type of relationship between documents." />
<valueSet value="http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.relatesTo.code" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".outboundRelationship.typeCode" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry Associations type" />
</mapping>
</element>
<element id="DocumentReference.relatesTo.target">
<path value="DocumentReference.relatesTo.target" />
<short value="Target of the relationship" />
<definition value="The target document of this relationship." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="1" />
<max value="1" />
<base>
<path value="DocumentReference.relatesTo.target" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/DocumentReference" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.relatesTo.target" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".target[classCode="DOC", moodCode="EVN"].id" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry Associations reference" />
</mapping>
</element>
<element id="DocumentReference.description">
<path value="DocumentReference.description" />
<short value="Human-readable description" />
<definition value="Human-readable description of the source document." />
<comment value="What the document is about, a terse summary of the document." />
<requirements value="Helps humans to assess whether the document is of interest." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.description" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-25" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".outboundRelationship[typeCode="SUBJ"].target.text" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.comments" />
</mapping>
</element>
<element id="DocumentReference.securityLabel">
<path value="DocumentReference.securityLabel" />
<short value="Document security-tags" />
<definition value="A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to." />
<comment value="The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n\nIn the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects." />
<requirements value="Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended." />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference.securityLabel" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="SecurityLabels" />
</extension>
<strength value="extensible" />
<description value="Security Labels from the Healthcare Privacy and Security Classification System." />
<valueSet value="http://hl7.org/fhir/ValueSet/security-labels" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.confidentiality, Composition.meta.security" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-18" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".confidentialityCode" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.confidentialityCode" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/confidentialityCode/@code" />
</mapping>
</element>
<element id="DocumentReference.content">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content" />
<short value="Document referenced" />
<definition value="The document and format referenced. There may be multiple content element repetitions, each with a different format." />
<min value="1" />
<max value="1" />
<base>
<path value="DocumentReference.content" />
<min value="1" />
<max value="*" />
</base>
<type>
<code value="BackboneElement" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Bundle(Composition+*)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="document.text" />
</mapping>
</element>
<element id="DocumentReference.content.id">
<path value="DocumentReference.content.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.content.extension">
<path value="DocumentReference.content.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.content.modifierExtension">
<path value="DocumentReference.content.modifierExtension" />
<short value="Extensions that cannot be ignored even if unrecognized" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<alias value="modifiers" />
<min value="0" />
<max value="*" />
<base>
<path value="BackboneElement.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.content.attachment">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</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/ca-core/ActorDefinition/consumer" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment" />
<short value="Where to access the document" />
<definition value="The document or URL of the document along with critical metadata to prove content has integrity." />
<comment value="When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent"." />
<min value="1" />
<max value="1" />
<base>
<path value="DocumentReference.content.attachment" />
<min value="1" />
<max value="1" />
</base>
<type>
<code value="Attachment" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="att-1" />
<severity value="error" />
<human value="If the Attachment has data, it SHALL have a contentType" />
<expression value="data.empty() or contentType.exists()" />
<xpath value="not(exists(f:data)) or exists(f:contentType)" />
<source value="http://hl7.org/fhir/StructureDefinition/Attachment" />
</constraint>
<mustSupport value="true" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="ED/RP" />
</mapping>
<mapping>
<identity value="rim" />
<map value="ED" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.language, \nComposition.title, \nComposition.date" />
</mapping>
<mapping>
<identity value="v2" />
<map value="TXA-3 for mime type" />
</mapping>
<mapping>
<identity value="rim" />
<map value="document.text" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.id">
<path value="DocumentReference.content.attachment.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.extension">
<path value="DocumentReference.content.attachment.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.contentType">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.contentType" />
<short value="Mime type of the content, with charset etc." />
<definition value="Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate." />
<requirements value="Processors of the data need to be able to know how to interpret the data." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.contentType" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<example>
<label value="General" />
<valueCode value="text/plain; charset=UTF-8, image/png" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="MimeType" />
</extension>
<strength value="required" />
<description value="The mime type of an attachment. Any valid mime type is allowed." />
<valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./mediaType, ./charset" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.language">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.language" />
<short value="Human language of the content (BCP-47)" />
<definition value="The human language of the content. The value can be any valid value according to BCP 47." />
<requirements value="Users need to be able to choose between the languages in a set of attachments." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.language" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<example>
<label value="General" />
<valueCode value="en-AU" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet">
<valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="Language" />
</extension>
<strength value="preferred" />
<description value="A human language." />
<valueSet value="http://hl7.org/fhir/ValueSet/languages|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="./language" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.data">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.data" />
<short value="Data inline, base64ed" />
<definition value="The actual data of the attachment - a sequence of bytes, base64 encoded." />
<comment value="The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON." />
<requirements value="The data needs to able to be transmitted inline." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.data" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="base64Binary" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="v2" />
<map value="ED.5" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./data" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.url">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.url" />
<short value="Uri where the data can be found" />
<definition value="A location where the data can be accessed." />
<comment value="If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data." />
<requirements value="The data needs to be transmitted by reference." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.url" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="url" />
</type>
<example>
<label value="General" />
<valueUrl value="http://www.acme.com/logo-small.png" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="RP.1+RP.2 - if they refer to a URL (see v2.6)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./reference/literal" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.size">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.size" />
<short value="Number of bytes of content (if url provided)" />
<definition value="The number of bytes of data that make up this attachment (before base64 encoding, if that is done)." />
<comment value="The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference." />
<requirements value="Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.size" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="unsignedInt" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A (needs data type R3 proposal)" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.hash">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.hash" />
<short value="Hash of the data (sha-1, base64ed)" />
<definition value="The calculated hash of the data using SHA-1. Represented using base64." />
<comment value="The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature." />
<requirements value="Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version)." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.hash" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="base64Binary" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value=".integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.title">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.title" />
<short value="Label to display in place of the data" />
<definition value="A label or set of text to display in place of the data." />
<requirements value="Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.title" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<example>
<label value="General" />
<valueString value="Official Corporate Logo" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="./title/data" />
</mapping>
</element>
<element id="DocumentReference.content.attachment.creation">
<path value="DocumentReference.content.attachment.creation" />
<short value="Date attachment was first created" />
<definition value="The date that the attachment was first created." />
<requirements value="This is often tracked as an integrity issue for use of the attachment." />
<min value="0" />
<max value="1" />
<base>
<path value="Attachment.creation" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="dateTime" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A (needs data type R3 proposal)" />
</mapping>
</element>
<element id="DocumentReference.content.format">
<path value="DocumentReference.content.format" />
<short value="Format/content rules for the document" />
<definition value="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." />
<comment value="Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.content.format" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Coding" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentFormat" />
</extension>
<strength value="preferred" />
<description value="Document Format Codes." />
<valueSet value="http://hl7.org/fhir/ValueSet/formatcodes" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE subset one of the sets of component 1-3 or 4-6" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CV" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:Coding rdfs:subClassOf dt:CDCoding" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.meta.profile" />
</mapping>
<mapping>
<identity value="rim" />
<map value="document.text" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.formatCode" />
</mapping>
<mapping>
<identity value="cda" />
<map value="derived from the IHE Profile or Implementation Guide templateID" />
</mapping>
</element>
<element id="DocumentReference.context">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.context" />
<short value="Clinical context of document" />
<definition value="The clinical context in which the document was prepared." />
<comment value="These values are primarily added to help with searching for interesting/relevant documents." />
<min value="1" />
<max value="1" />
<base>
<path value="DocumentReference.context" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="BackboneElement" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']" />
</mapping>
</element>
<element id="DocumentReference.context.id">
<path value="DocumentReference.context.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.context.extension">
<path value="DocumentReference.context.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.context.modifierExtension">
<path value="DocumentReference.context.modifierExtension" />
<short value="Extensions that cannot be ignored even if unrecognized" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension)." />
<alias value="extensions" />
<alias value="user content" />
<alias value="modifiers" />
<min value="0" />
<max value="*" />
<base>
<path value="BackboneElement.modifierExtension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="true" />
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.context.encounter">
<path value="DocumentReference.context.encounter" />
<short value="Context of the document content" />
<definition value="Describes the clinical encounter or type of care that the document content is associated with." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference.context.encounter" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Encounter" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="workflow" />
<map value="Event.context" />
</mapping>
<mapping>
<identity value="w5" />
<map value="FiveWs.context" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.encounter" />
</mapping>
<mapping>
<identity value="rim" />
<map value="unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])" />
</mapping>
</element>
<element id="DocumentReference.context.event">
<path value="DocumentReference.context.event" />
<short value="Main clinical acts documented" />
<definition value="This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act." />
<comment value="An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation." />
<min value="0" />
<max value="*" />
<base>
<path value="DocumentReference.context.event" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentEventType" />
</extension>
<strength value="example" />
<description value="This list of codes represents the main clinical acts being documented." />
<valueSet value="http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.event.code" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".code" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.eventCodeList" />
</mapping>
</element>
<element id="DocumentReference.context.period">
<path value="DocumentReference.context.period" />
<short value="Time of service that is being documented" />
<definition value="The time period over which the service that is described by the document was provided." />
<comment value="A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration)." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.context.period" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Period" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="per-1" />
<severity value="error" />
<human value="If present, start SHALL have a lower value than end" />
<expression value="start.hasValue().not() or end.hasValue().not() or (start <= end)" />
<xpath value="not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))" />
<source value="http://hl7.org/fhir/StructureDefinition/Period" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="DR" />
</mapping>
<mapping>
<identity value="rim" />
<map value="IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.event.period" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".effectiveTime" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/low/\n@value --> ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/high/\n@value" />
</mapping>
</element>
<element id="DocumentReference.context.facilityType">
<path value="DocumentReference.context.facilityType" />
<short value="Kind of facility where patient was seen" />
<definition value="The kind of facility where the patient was seen." />
<comment value="Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.context.facilityType" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentC80FacilityType" />
</extension>
<strength value="example" />
<description value="XDS Facility Type." />
<valueSet value="http://hl7.org/fhir/ValueSet/c80-facilitycodes" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="usually from a mapping to a local ValueSet" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode="LOC"].role[classCode="DSDLOC"].code" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.healthcareFacilityTypeCode" />
</mapping>
<mapping>
<identity value="cda" />
<map value="usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code" />
</mapping>
</element>
<element id="DocumentReference.context.practiceSetting">
<path value="DocumentReference.context.practiceSetting" />
<short value="Additional details about where the content was created (e.g. clinical specialty)" />
<definition value="This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty." />
<comment value="This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC." />
<requirements value="This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.context.practiceSetting" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="DocumentC80PracticeSetting" />
</extension>
<strength value="example" />
<description value="Additional details about where the content was created (e.g. clinical specialty)." />
<valueSet value="http://hl7.org/fhir/ValueSet/c80-practice-codes" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="CE/CNE/CWE" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:CodeableConcept rdfs:subClassOf dt:CD" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="usually from a mapping to a local ValueSet" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode="LOC"].role[classCode="DSDLOC"].code" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.practiceSettingCode" />
</mapping>
<mapping>
<identity value="cda" />
<map value="usually from a mapping to a local ValueSet" />
</mapping>
</element>
<element id="DocumentReference.context.sourcePatientInfo">
<path value="DocumentReference.context.sourcePatientInfo" />
<short value="Patient demographics from source" />
<definition value="The Patient Information as known when the document was published. May be a reference to a version specific, or contained." />
<comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
<min value="0" />
<max value="1" />
<base>
<path value="DocumentReference.context.sourcePatientInfo" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.subject" />
</mapping>
<mapping>
<identity value="rim" />
<map value=".participation[typeCode="SBJ"].role[typeCode="PAT"]" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/recordTarget/" />
</mapping>
</element>
<element id="DocumentReference.context.related">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.context.related" />
<short value="Related identifiers or resources" />
<definition value="Related identifiers or resources associated with the DocumentReference." />
<comment value="May be identifiers or resources that caused the DocumentReference or referenced Document to be created." />
<min value="1" />
<max value="1" />
<base>
<path value="DocumentReference.context.related" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/service-request" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ref-1" />
<severity value="error" />
<human value="SHALL have a contained resource if a local reference is provided" />
<expression value="reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))" />
<xpath value="not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Reference" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="The target of a resource reference is a RIM entry point (Act, Role, or Entity)" />
</mapping>
<mapping>
<identity value="fhircomposition" />
<map value="Composition.event.detail" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]" />
</mapping>
<mapping>
<identity value="xds" />
<map value="DocumentEntry.referenceIdList" />
</mapping>
<mapping>
<identity value="cda" />
<map value="ClinicalDocument/relatedDocument" />
</mapping>
</element>
<element id="DocumentReference.context.related.id">
<path value="DocumentReference.context.related.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.context.related.extension">
<path value="DocumentReference.context.related.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.context.related.reference">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.context.related.reference" />
<short value="Literal reference, Relative, internal or absolute URL" />
<definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources." />
<comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.reference" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ref-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.context.related.type">
<path value="DocumentReference.context.related.type" />
<short value="Type the reference refers to (e.g. "Patient")" />
<definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)." />
<comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="FHIRResourceTypeExt" />
</extension>
<strength value="extensible" />
<description value="Aa resource (or, for logical models, the URI of the logical model)." />
<valueSet value="http://hl7.org/fhir/ValueSet/resource-types|4.0.1" />
</binding>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier" />
<short value="Logical reference, when literal reference is not known" />
<definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." />
<comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.identifier" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Identifier" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value=".identifier" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.id">
<path value="DocumentReference.context.related.identifier.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.extension">
<path value="DocumentReference.context.related.identifier.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<isModifier value="false" />
<isSummary value="false" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.use">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier.use" />
<short value="usual | official | temp | secondary | old (If known)" />
<definition value="The purpose of this identifier." />
<comment value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary." />
<requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.use" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="true" />
<isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one." />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierUse" />
</extension>
<strength value="required" />
<description value="Identifies the purpose for this identifier, if known ." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-use|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.type">
<path value="DocumentReference.context.related.identifier.type" />
<short value="Description of identifier" />
<definition value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." />
<comment value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type." />
<requirements value="Allows users to make use of identifiers when the identifier system is not known." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.type" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="CodeableConcept" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<binding>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
<valueString value="IdentifierType" />
</extension>
<strength value="extensible" />
<description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose." />
<valueSet value="http://hl7.org/fhir/ValueSet/identifier-type|4.0.1" />
</binding>
<mapping>
<identity value="v2" />
<map value="CX.5" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.code or implied by context" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier.system" />
<short value="The namespace for the identifier value" />
<definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique." />
<comment value="Identifier.system is always case sensitive." />
<requirements value="There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.system" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<example>
<label value="General" />
<valueUri value="http://www.acme.com/identifiers/patient" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.4 / EI-2-4" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.root or Role.id.root" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierType" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier.value" />
<short value="The value that is unique" />
<definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system." />
<comment value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe." />
<min value="1" />
<max value="1" />
<base>
<path value="Identifier.value" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<example>
<label value="General" />
<valueString value="123456" />
</example>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.1 / EI.1" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./Value" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.period">
<path value="DocumentReference.context.related.identifier.period" />
<short value="Time period when id is/was valid for use" />
<definition value="Time period during which identifier is/was valid for use." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.period" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Period" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.7 + CX.8" />
</mapping>
<mapping>
<identity value="rim" />
<map value="Role.effectiveTime or implied by context" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./StartDate and ./EndDate" />
</mapping>
</element>
<element id="DocumentReference.context.related.identifier.assigner">
<path value="DocumentReference.context.related.identifier.assigner" />
<short value="Organization that issued id (may be just text)" />
<definition value="Organization that issued/manages the identifier." />
<comment value="The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization." />
<min value="0" />
<max value="1" />
<base>
<path value="Identifier.assigner" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization|4.0.1" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="v2" />
<map value="CX.4 / (CX.4,CX.9,CX.10)" />
</mapping>
<mapping>
<identity value="rim" />
<map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" />
</mapping>
<mapping>
<identity value="servd" />
<map value="./IdentifierIssuingAuthority" />
</mapping>
</element>
<element id="DocumentReference.context.related.display">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<path value="DocumentReference.context.related.display" />
<short value="Text alternative for the resource" />
<definition value="Plain text narrative that identifies the resource in addition to the resource reference." />
<comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it." />
<min value="0" />
<max value="1" />
<base>
<path value="Reference.display" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isModifier value="false" />
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
</snapshot>
<differential>
<element id="DocumentReference">
<path value="DocumentReference" />
</element>
<element id="DocumentReference.meta">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.meta" />
</element>
<element id="DocumentReference.meta.profile">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.meta.profile" />
<comment value="Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to." />
</element>
<element id="DocumentReference.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.identifier" />
</element>
<element id="DocumentReference.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.identifier.system" />
</element>
<element id="DocumentReference.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.identifier.value" />
</element>
<element id="DocumentReference.status">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.status" />
<patternCode value="current" />
</element>
<element id="DocumentReference.type">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.type" />
</element>
<element id="DocumentReference.subject">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.subject" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/patient" />
</type>
</element>
<element id="DocumentReference.subject.reference">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.subject.reference" />
</element>
<element id="DocumentReference.subject.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.subject.identifier" />
</element>
<element id="DocumentReference.subject.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.subject.identifier.system" />
<min value="1" />
</element>
<element id="DocumentReference.subject.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.subject.identifier.value" />
<min value="1" />
</element>
<element id="DocumentReference.date">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.date" />
</element>
<element id="DocumentReference.author">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.author" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner-role" />
</type>
</element>
<element id="DocumentReference.author.reference">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.author.reference" />
</element>
<element id="DocumentReference.author.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.author.identifier" />
</element>
<element id="DocumentReference.author.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.author.identifier.system" />
<min value="1" />
</element>
<element id="DocumentReference.author.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.author.identifier.value" />
<min value="1" />
</element>
<element id="DocumentReference.content">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content" />
<max value="1" />
</element>
<element id="DocumentReference.content.attachment">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/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/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment" />
</element>
<element id="DocumentReference.content.attachment.contentType">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.contentType" />
</element>
<element id="DocumentReference.content.attachment.language">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.language" />
</element>
<element id="DocumentReference.content.attachment.data">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.data" />
</element>
<element id="DocumentReference.content.attachment.url">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.url" />
</element>
<element id="DocumentReference.content.attachment.size">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.size" />
</element>
<element id="DocumentReference.content.attachment.hash">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.hash" />
</element>
<element id="DocumentReference.content.attachment.title">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.content.attachment.title" />
</element>
<element id="DocumentReference.context">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.context" />
<min value="1" />
</element>
<element id="DocumentReference.context.related">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.context.related" />
<min value="1" />
<max value="1" />
<type>
<code value="Reference" />
<targetProfile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/service-request" />
</type>
</element>
<element id="DocumentReference.context.related.reference">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.context.related.reference" />
</element>
<element id="DocumentReference.context.related.identifier">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier" />
</element>
<element id="DocumentReference.context.related.identifier.use">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier.use" />
<min value="1" />
</element>
<element id="DocumentReference.context.related.identifier.system">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier.system" />
<min value="1" />
</element>
<element id="DocumentReference.context.related.identifier.value">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="name">
<valueString value="pcare" />
</extension>
<extension url="code">
<valueCode value="SHALL:populate" />
</extension>
<extension url="code">
<valueCode value="SHALL:persist" />
</extension>
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="documentation">
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server" />
</extension>
</extension>
<path value="DocumentReference.context.related.identifier.value" />
<min value="1" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "document-reference",
"text": {
"status": "extensions",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference",
"version": "0.1.0",
"name": "PCareDocumentReference",
"title": "P-Care Document Reference",
"status": "draft",
"date": "2026-10-19T22:14:59+00:00",
"publisher": "Infoway",
"description": "A reference to a document of any kind for any purpose.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "DocumentReference",
"baseDefinition": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.1.0"
}
],
"element": [
{
"id": "DocumentReference",
"path": "DocumentReference",
"short": "A reference to a document",
"definition": "A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.",
"comment": "Usually, this is used for documents other than those defined by FHIR.",
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "fhircomposition",
"map": "when describing a Composition"
},
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]"
},
{
"identity": "cda",
"map": "when describing a CDA"
}
]
},
{
"id": "DocumentReference.id",
"path": "DocumentReference.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.meta",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.meta.id",
"path": "DocumentReference.meta.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.meta.extension",
"path": "DocumentReference.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.meta.versionId",
"path": "DocumentReference.meta.versionId",
"short": "Version specific identifier",
"definition": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "DocumentReference.meta.lastUpdated",
"path": "DocumentReference.meta.lastUpdated",
"short": "When the resource version last changed",
"definition": "When the resource last changed - e.g. when the version changed.",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "DocumentReference.meta.source",
"path": "DocumentReference.meta.source",
"short": "Identifies where the resource comes from",
"definition": "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.",
"comment": "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.source",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "DocumentReference.meta.profile",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.meta.profile",
"short": "Profiles this resource claims to conform to",
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).",
"comment": "Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/StructureDefinition|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "DocumentReference.meta.security",
"path": "DocumentReference.meta.security",
"short": "Security Labels applied to this resource",
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet": "http://hl7.org/fhir/ValueSet/security-labels|4.0.1"
}
},
{
"id": "DocumentReference.meta.tag",
"path": "DocumentReference.meta.tag",
"short": "Tags applied to this resource",
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
}
],
"strength": "example",
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\".",
"valueSet": "http://hl7.org/fhir/ValueSet/common-tags|4.0.1"
}
},
{
"id": "DocumentReference.implicitRules",
"path": "DocumentReference.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.language",
"path": "DocumentReference.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.text",
"path": "DocumentReference.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "DocumentReference.contained",
"path": "DocumentReference.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.extension",
"path": "DocumentReference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.modifierExtension",
"path": "DocumentReference.modifierExtension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.masterIdentifier",
"path": "DocumentReference.masterIdentifier",
"short": "Master Version Specific Identifier",
"definition": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.",
"comment": "CDA Document Id extension and root.",
"requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form \"oid^extension\", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.masterIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "rim",
"map": "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]"
},
{
"identity": "servd",
"map": "Identifier"
},
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "fhircomposition",
"map": "Composition.identifier"
},
{
"identity": "v2",
"map": "TXA-12"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "xds",
"map": "DocumentEntry.uniqueId"
},
{
"identity": "cda",
"map": "ClinicalDocument/id"
}
]
},
{
"id": "DocumentReference.identifier",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.identifier",
"short": "Other identifiers for the document",
"definition": "Other identifiers associated with the document, including version independent identifiers.",
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "rim",
"map": "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]"
},
{
"identity": "servd",
"map": "Identifier"
},
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "v2",
"map": "TXA-16?"
},
{
"identity": "rim",
"map": ".id / .setId"
},
{
"identity": "xds",
"map": "DocumentEntry.entryUUID"
}
]
},
{
"id": "DocumentReference.identifier.id",
"path": "DocumentReference.identifier.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.identifier.extension",
"path": "DocumentReference.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.identifier.use",
"path": "DocumentReference.identifier.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.identifier.type",
"path": "DocumentReference.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.identifier.system",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "DocumentReference.identifier.value",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "DocumentReference.identifier.period",
"path": "DocumentReference.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower value than end",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source": "http://hl7.org/fhir/StructureDefinition/Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR"
},
{
"identity": "rim",
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "DocumentReference.identifier.assigner",
"path": "DocumentReference.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "DocumentReference.status",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.status",
"short": "current | superseded | entered-in-error",
"definition": "The status of this document reference.",
"comment": "This is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentReference.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"patternCode": "current",
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentReferenceStatus"
}
],
"strength": "required",
"description": "The status of the document reference.",
"valueSet": "http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "TXA-19"
},
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\"; final: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]); amended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
},
{
"identity": "xds",
"map": "DocumentEntry.availabilityStatus"
}
]
},
{
"id": "DocumentReference.docStatus",
"path": "DocumentReference.docStatus",
"short": "preliminary | final | amended | entered-in-error",
"definition": "The status of the underlying document.",
"comment": "The document that is pointed to might be in various lifecycle states.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.docStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ReferredDocumentStatus"
}
],
"strength": "required",
"description": "Status of the underlying document.",
"valueSet": "http://hl7.org/fhir/ValueSet/composition-status|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "fhircomposition",
"map": "Composition.status"
},
{
"identity": "v2",
"map": "TXA-17"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"id": "DocumentReference.type",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.type",
"short": "Kind of document (LOINC if possible)",
"definition": "Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.",
"comment": "Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80Type"
}
],
"strength": "preferred",
"description": "Precise type of clinical document.",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-doc-typecodes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "fhircomposition",
"map": "Composition.type"
},
{
"identity": "v2",
"map": "TXA-2"
},
{
"identity": "rim",
"map": "./code"
},
{
"identity": "xds",
"map": "DocumentEntry.type"
},
{
"identity": "cda",
"map": "ClinicalDocument/code/@code \n\nThe typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted."
}
]
},
{
"id": "DocumentReference.category",
"path": "DocumentReference.category",
"short": "Categorization of document",
"definition": "A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.",
"comment": "Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.",
"alias": [
"claxs"
],
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference.category",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80Class"
}
],
"strength": "example",
"description": "High-level kind of a clinical document at a macro level.",
"valueSet": "http://hl7.org/fhir/ValueSet/document-classcodes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "fhircomposition",
"map": "Composition.class"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity": "xds",
"map": "DocumentEntry.class"
},
{
"identity": "cda",
"map": "Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code"
}
]
},
{
"id": "DocumentReference.subject",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject",
"short": "Who/what is the subject of the document",
"definition": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/patient"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "fhircomposition",
"map": "Composition.subject"
},
{
"identity": "v2",
"map": "PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
},
{
"identity": "xds",
"map": "DocumentEntry.patientId"
},
{
"identity": "cda",
"map": "ClinicalDocument/recordTarget/"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "DocumentReference.subject.id",
"path": "DocumentReference.subject.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.subject.extension",
"path": "DocumentReference.subject.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.subject.reference",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.subject.type",
"path": "DocumentReference.subject.type",
"short": "Type the reference refers to (e.g. \"Patient\")",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}
],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.subject.identifier",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "DocumentReference.subject.identifier.id",
"path": "DocumentReference.subject.identifier.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.subject.identifier.extension",
"path": "DocumentReference.subject.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.subject.identifier.use",
"path": "DocumentReference.subject.identifier.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.subject.identifier.type",
"path": "DocumentReference.subject.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.subject.identifier.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "DocumentReference.subject.identifier.value",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "DocumentReference.subject.identifier.period",
"path": "DocumentReference.subject.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "DocumentReference.subject.identifier.assigner",
"path": "DocumentReference.subject.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "DocumentReference.subject.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "DocumentReference.subject.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.date",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.date",
"short": "When this document reference was created",
"definition": "When the document reference was created.",
"comment": "Referencing/indexing time is used for tracking, organizing versions and searching.",
"alias": [
"indexed"
],
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "workflow",
"map": "Event.occurrence[x]"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "fhircomposition",
"map": "Composition.date"
},
{
"identity": "rim",
"map": ".availabilityTime[type=\"TS\"]"
}
]
},
{
"id": "DocumentReference.author",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author",
"short": "Who and/or what authored the document",
"definition": "Identifies who is responsible for adding the information to the document.",
"comment": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference.author",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner",
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner-role"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "fhircomposition",
"map": "Composition.author"
},
{
"identity": "v2",
"map": "TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "xds",
"map": "DocumentEntry.author"
},
{
"identity": "cda",
"map": "ClinicalDocument/author"
}
]
},
{
"id": "DocumentReference.author.id",
"path": "DocumentReference.author.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.author.extension",
"path": "DocumentReference.author.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.author.reference",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1",
"ref-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.author.type",
"path": "DocumentReference.author.type",
"short": "Type the reference refers to (e.g. \"Patient\")",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}
],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.author.identifier",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity": "rim",
"map": "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]"
},
{
"identity": "servd",
"map": "Identifier"
},
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "DocumentReference.author.identifier.id",
"path": "DocumentReference.author.identifier.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.author.identifier.extension",
"path": "DocumentReference.author.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.author.identifier.use",
"path": "DocumentReference.author.identifier.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.author.identifier.type",
"path": "DocumentReference.author.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.author.identifier.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "DocumentReference.author.identifier.value",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "DocumentReference.author.identifier.period",
"path": "DocumentReference.author.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "DocumentReference.author.identifier.assigner",
"path": "DocumentReference.author.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "DocumentReference.author.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "DocumentReference.author.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.authenticator",
"path": "DocumentReference.authenticator",
"short": "Who/what authenticated the document",
"definition": "Which person or organization authenticates that this document is valid.",
"comment": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.authenticator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "fhircomposition",
"map": "Composition.attester"
},
{
"identity": "v2",
"map": "TXA-10"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
},
{
"identity": "xds",
"map": "DocumentEntry.legalAuthenticator"
},
{
"identity": "cda",
"map": "ClinicalDocument/legalAuthenticator"
}
]
},
{
"id": "DocumentReference.custodian",
"path": "DocumentReference.custodian",
"short": "Organization which maintains the document",
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.",
"comment": "Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.custodian",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "fhircomposition",
"map": "Composition.custodian"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
}
]
},
{
"id": "DocumentReference.relatesTo",
"path": "DocumentReference.relatesTo",
"short": "Relationships to other documents",
"definition": "Relationships that this document has with other document references that already exist.",
"comment": "This element is labeled as a modifier because documents that append to other documents are incomplete on their own.",
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference.relatesTo",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "fhircomposition",
"map": "Composition.relatesTo"
},
{
"identity": "rim",
"map": ".outboundRelationship"
},
{
"identity": "xds",
"map": "DocumentEntry Associations"
}
]
},
{
"id": "DocumentReference.relatesTo.id",
"path": "DocumentReference.relatesTo.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.relatesTo.extension",
"path": "DocumentReference.relatesTo.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.relatesTo.modifierExtension",
"path": "DocumentReference.relatesTo.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.relatesTo.code",
"path": "DocumentReference.relatesTo.code",
"short": "replaces | transforms | signs | appends",
"definition": "The type of relationship that this document has with anther document.",
"comment": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentReference.relatesTo.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentRelationshipType"
}
],
"strength": "required",
"description": "The type of relationship between documents.",
"valueSet": "http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "fhircomposition",
"map": "Composition.relatesTo.code"
},
{
"identity": "rim",
"map": ".outboundRelationship.typeCode"
},
{
"identity": "xds",
"map": "DocumentEntry Associations type"
}
]
},
{
"id": "DocumentReference.relatesTo.target",
"path": "DocumentReference.relatesTo.target",
"short": "Target of the relationship",
"definition": "The target document of this relationship.",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentReference.relatesTo.target",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "fhircomposition",
"map": "Composition.relatesTo.target"
},
{
"identity": "rim",
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id"
},
{
"identity": "xds",
"map": "DocumentEntry Associations reference"
}
]
},
{
"id": "DocumentReference.description",
"path": "DocumentReference.description",
"short": "Human-readable description",
"definition": "Human-readable description of the source document.",
"comment": "What the document is about, a terse summary of the document.",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "TXA-25"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text"
},
{
"identity": "xds",
"map": "DocumentEntry.comments"
}
]
},
{
"id": "DocumentReference.securityLabel",
"path": "DocumentReference.securityLabel",
"short": "Document security-tags",
"definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the \"reference\" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.",
"comment": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n\nIn the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.",
"requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.",
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference.securityLabel",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSet": "http://hl7.org/fhir/ValueSet/security-labels"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "fhircomposition",
"map": "Composition.confidentiality, Composition.meta.security"
},
{
"identity": "v2",
"map": "TXA-18"
},
{
"identity": "rim",
"map": ".confidentialityCode"
},
{
"identity": "xds",
"map": "DocumentEntry.confidentialityCode"
},
{
"identity": "cda",
"map": "ClinicalDocument/confidentialityCode/@code"
}
]
},
{
"id": "DocumentReference.content",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content",
"short": "Document referenced",
"definition": "The document and format referenced. There may be multiple content element repetitions, each with a different format.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentReference.content",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "fhircomposition",
"map": "Bundle(Composition+*)"
},
{
"identity": "rim",
"map": "document.text"
}
]
},
{
"id": "DocumentReference.content.id",
"path": "DocumentReference.content.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.content.extension",
"path": "DocumentReference.content.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.content.modifierExtension",
"path": "DocumentReference.content.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.content.attachment",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/documentreference-ca-core|1.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment",
"short": "Where to access the document",
"definition": "The document or URL of the document along with critical metadata to prove content has integrity.",
"comment": "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as \"Signed Procedure Consent\".",
"min": 1,
"max": "1",
"base": {
"path": "DocumentReference.content.attachment",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Attachment"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "att-1",
"severity": "error",
"human": "If the Attachment has data, it SHALL have a contentType",
"expression": "data.empty() or contentType.exists()",
"xpath": "not(exists(f:data)) or exists(f:contentType)",
"source": "http://hl7.org/fhir/StructureDefinition/Attachment"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "ED/RP"
},
{
"identity": "rim",
"map": "ED"
},
{
"identity": "fhircomposition",
"map": "Composition.language, \nComposition.title, \nComposition.date"
},
{
"identity": "v2",
"map": "TXA-3 for mime type"
},
{
"identity": "rim",
"map": "document.text"
},
{
"identity": "xds",
"map": "DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime"
},
{
"identity": "cda",
"map": "ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date"
}
]
},
{
"id": "DocumentReference.content.attachment.id",
"path": "DocumentReference.content.attachment.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.content.attachment.extension",
"path": "DocumentReference.content.attachment.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.content.attachment.contentType",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.contentType",
"short": "Mime type of the content, with charset etc.",
"definition": "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"requirements": "Processors of the data need to be able to know how to interpret the data.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.contentType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"example": [
{
"label": "General",
"valueCode": "text/plain; charset=UTF-8, image/png"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MimeType"
}
],
"strength": "required",
"description": "The mime type of an attachment. Any valid mime type is allowed.",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used"
},
{
"identity": "rim",
"map": "./mediaType, ./charset"
}
]
},
{
"id": "DocumentReference.content.attachment.language",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.language",
"short": "Human language of the content (BCP-47)",
"definition": "The human language of the content. The value can be any valid value according to BCP 47.",
"requirements": "Users need to be able to choose between the languages in a set of attachments.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"example": [
{
"label": "General",
"valueCode": "en-AU"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "./language"
}
]
},
{
"id": "DocumentReference.content.attachment.data",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.data",
"short": "Data inline, base64ed",
"definition": "The actual data of the attachment - a sequence of bytes, base64 encoded.",
"comment": "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"requirements": "The data needs to able to be transmitted inline.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.data",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "ED.5"
},
{
"identity": "rim",
"map": "./data"
}
]
},
{
"id": "DocumentReference.content.attachment.url",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.url",
"short": "Uri where the data can be found",
"definition": "A location where the data can be accessed.",
"comment": "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"requirements": "The data needs to be transmitted by reference.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "url"
}
],
"example": [
{
"label": "General",
"valueUrl": "http://www.acme.com/logo-small.png"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RP.1+RP.2 - if they refer to a URL (see v2.6)"
},
{
"identity": "rim",
"map": "./reference/literal"
}
]
},
{
"id": "DocumentReference.content.attachment.size",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.size",
"short": "Number of bytes of content (if url provided)",
"definition": "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"comment": "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"requirements": "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.size",
"min": 0,
"max": "1"
},
"type": [
{
"code": "unsignedInt"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (needs data type R3 proposal)"
}
]
},
{
"id": "DocumentReference.content.attachment.hash",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.hash",
"short": "Hash of the data (sha-1, base64ed)",
"definition": "The calculated hash of the data using SHA-1. Represented using base64.",
"comment": "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.",
"requirements": "Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.hash",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".integrityCheck[parent::ED/integrityCheckAlgorithm=\"SHA-1\"]"
}
]
},
{
"id": "DocumentReference.content.attachment.title",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.title",
"short": "Label to display in place of the data",
"definition": "A label or set of text to display in place of the data.",
"requirements": "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "Official Corporate Logo"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./title/data"
}
]
},
{
"id": "DocumentReference.content.attachment.creation",
"path": "DocumentReference.content.attachment.creation",
"short": "Date attachment was first created",
"definition": "The date that the attachment was first created.",
"requirements": "This is often tracked as an integrity issue for use of the attachment.",
"min": 0,
"max": "1",
"base": {
"path": "Attachment.creation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (needs data type R3 proposal)"
}
]
},
{
"id": "DocumentReference.content.format",
"path": "DocumentReference.content.format",
"short": "Format/content rules for the document",
"definition": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.",
"comment": "Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.content.format",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentFormat"
}
],
"strength": "preferred",
"description": "Document Format Codes.",
"valueSet": "http://hl7.org/fhir/ValueSet/formatcodes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity": "rim",
"map": "CV"
},
{
"identity": "orim",
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"identity": "fhircomposition",
"map": "Composition.meta.profile"
},
{
"identity": "rim",
"map": "document.text"
},
{
"identity": "xds",
"map": "DocumentEntry.formatCode"
},
{
"identity": "cda",
"map": "derived from the IHE Profile or Implementation Guide templateID"
}
]
},
{
"id": "DocumentReference.context",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context",
"short": "Clinical context of document",
"definition": "The clinical context in which the document was prepared.",
"comment": "These values are primarily added to help with searching for interesting/relevant documents.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentReference.context",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
}
]
},
{
"id": "DocumentReference.context.id",
"path": "DocumentReference.context.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.context.extension",
"path": "DocumentReference.context.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.context.modifierExtension",
"path": "DocumentReference.context.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.context.encounter",
"path": "DocumentReference.context.encounter",
"short": "Context of the document content",
"definition": "Describes the clinical encounter or type of care that the document content is associated with.",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference.context.encounter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Encounter",
"http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "w5",
"map": "FiveWs.context"
},
{
"identity": "fhircomposition",
"map": "Composition.encounter"
},
{
"identity": "rim",
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])"
}
]
},
{
"id": "DocumentReference.context.event",
"path": "DocumentReference.context.event",
"short": "Main clinical acts documented",
"definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comment": "An event can further specialize the act inherent in the type, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.",
"min": 0,
"max": "*",
"base": {
"path": "DocumentReference.context.event",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentEventType"
}
],
"strength": "example",
"description": "This list of codes represents the main clinical acts being documented.",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "fhircomposition",
"map": "Composition.event.code"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "xds",
"map": "DocumentEntry.eventCodeList"
}
]
},
{
"id": "DocumentReference.context.period",
"path": "DocumentReference.context.period",
"short": "Time of service that is being documented",
"definition": "The time period over which the service that is described by the document was provided.",
"comment": "A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\").\n\nPeriod is not used for a duration (a measure of elapsed time). See [Duration](http://hl7.org/fhir/R4/datatypes.html#Duration).",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.context.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "per-1",
"severity": "error",
"human": "If present, start SHALL have a lower value than end",
"expression": "start.hasValue().not() or end.hasValue().not() or (start <= end)",
"xpath": "not(exists(f:start/@value)) or not(exists(f:end/@value)) or (xs:dateTime(f:start/@value) <= xs:dateTime(f:end/@value))",
"source": "http://hl7.org/fhir/StructureDefinition/Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "DR"
},
{
"identity": "rim",
"map": "IVL<TS>[lowClosed=\"true\" and highClosed=\"true\"] or URG<TS>[lowClosed=\"true\" and highClosed=\"true\"]"
},
{
"identity": "fhircomposition",
"map": "Composition.event.period"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "xds",
"map": "DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime"
},
{
"identity": "cda",
"map": "ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/low/\n@value --> ClinicalDocument/documentationOf/\nserviceEvent/effectiveTime/high/\n@value"
}
]
},
{
"id": "DocumentReference.context.facilityType",
"path": "DocumentReference.context.facilityType",
"short": "Kind of facility where patient was seen",
"definition": "The kind of facility where the patient was seen.",
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.context.facilityType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80FacilityType"
}
],
"strength": "example",
"description": "XDS Facility Type.",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-facilitycodes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "fhircomposition",
"map": "usually from a mapping to a local ValueSet"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code"
},
{
"identity": "xds",
"map": "DocumentEntry.healthcareFacilityTypeCode"
},
{
"identity": "cda",
"map": "usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code"
}
]
},
{
"id": "DocumentReference.context.practiceSetting",
"path": "DocumentReference.context.practiceSetting",
"short": "Additional details about where the content was created (e.g. clinical specialty)",
"definition": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.",
"comment": "This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.",
"requirements": "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.context.practiceSetting",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DocumentC80PracticeSetting"
}
],
"strength": "example",
"description": "Additional details about where the content was created (e.g. clinical specialty).",
"valueSet": "http://hl7.org/fhir/ValueSet/c80-practice-codes"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "CE/CNE/CWE"
},
{
"identity": "rim",
"map": "CD"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity": "fhircomposition",
"map": "usually from a mapping to a local ValueSet"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code"
},
{
"identity": "xds",
"map": "DocumentEntry.practiceSettingCode"
},
{
"identity": "cda",
"map": "usually from a mapping to a local ValueSet"
}
]
},
{
"id": "DocumentReference.context.sourcePatientInfo",
"path": "DocumentReference.context.sourcePatientInfo",
"short": "Patient demographics from source",
"definition": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained.",
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentReference.context.sourcePatientInfo",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "fhircomposition",
"map": "Composition.subject"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
},
{
"identity": "xds",
"map": "DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId"
},
{
"identity": "cda",
"map": "ClinicalDocument/recordTarget/"
}
]
},
{
"id": "DocumentReference.context.related",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related",
"short": "Related identifiers or resources",
"definition": "Related identifiers or resources associated with the DocumentReference.",
"comment": "May be identifiers or resources that caused the DocumentReference or referenced Document to be created.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentReference.context.related",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/service-request"
]
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ref-1",
"severity": "error",
"human": "SHALL have a contained resource if a local reference is provided",
"expression": "reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"source": "http://hl7.org/fhir/StructureDefinition/Reference"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity": "fhircomposition",
"map": "Composition.event.detail"
},
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()] / target[isNormalAct]"
},
{
"identity": "xds",
"map": "DocumentEntry.referenceIdList"
},
{
"identity": "cda",
"map": "ClinicalDocument/relatedDocument"
}
]
},
{
"id": "DocumentReference.context.related.id",
"path": "DocumentReference.context.related.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.context.related.extension",
"path": "DocumentReference.context.related.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.context.related.reference",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.context.related.type",
"path": "DocumentReference.context.related.type",
"short": "Type the reference refers to (e.g. \"Patient\")",
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRResourceTypeExt"
}
],
"strength": "extensible",
"description": "Aa resource (or, for logical models, the URI of the logical model).",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types|4.0.1"
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "DocumentReference.context.related.identifier",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "DocumentReference.context.related.identifier.id",
"path": "DocumentReference.context.related.identifier.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.context.related.identifier.extension",
"path": "DocumentReference.context.related.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DocumentReference.context.related.identifier.use",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier.use",
"short": "usual | official | temp | secondary | old (If known)",
"definition": "The purpose of this identifier.",
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.context.related.identifier.type",
"path": "DocumentReference.context.related.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type|4.0.1"
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "DocumentReference.context.related.identifier.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment": "Identifier.system is always case sensitive.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "DocumentReference.context.related.identifier.value",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/document-reference|0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "DocumentReference.context.related.identifier.period",
"path": "DocumentReference.context.related.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "DocumentReference.context.related.identifier.assigner",
"path": "DocumentReference.context.related.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization|4.0.1"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "DocumentReference.context.related.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "DocumentReference.context.related.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "DocumentReference",
"path": "DocumentReference"
},
{
"id": "DocumentReference.meta",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.meta"
},
{
"id": "DocumentReference.meta.profile",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.meta.profile",
"comment": "Implementers should be aware that some Canadian jurisdictions require vendors to use meta.profile to declare which FHIR profile(s) and version(s) the resource conforms to."
},
{
"id": "DocumentReference.identifier",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.identifier"
},
{
"id": "DocumentReference.identifier.system",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.identifier.system"
},
{
"id": "DocumentReference.identifier.value",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.identifier.value"
},
{
"id": "DocumentReference.status",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.status",
"patternCode": "current"
},
{
"id": "DocumentReference.type",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.type"
},
{
"id": "DocumentReference.subject",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/patient"
]
}
]
},
{
"id": "DocumentReference.subject.reference",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.reference"
},
{
"id": "DocumentReference.subject.identifier",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.identifier"
},
{
"id": "DocumentReference.subject.identifier.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.identifier.system",
"min": 1
},
{
"id": "DocumentReference.subject.identifier.value",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.subject.identifier.value",
"min": 1
},
{
"id": "DocumentReference.date",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.date"
},
{
"id": "DocumentReference.author",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner",
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/practitioner-role"
]
}
]
},
{
"id": "DocumentReference.author.reference",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.reference"
},
{
"id": "DocumentReference.author.identifier",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.identifier"
},
{
"id": "DocumentReference.author.identifier.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.identifier.system",
"min": 1
},
{
"id": "DocumentReference.author.identifier.value",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.author.identifier.value",
"min": 1
},
{
"id": "DocumentReference.content",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content",
"max": "1"
},
{
"id": "DocumentReference.content.attachment",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment"
},
{
"id": "DocumentReference.content.attachment.contentType",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.contentType"
},
{
"id": "DocumentReference.content.attachment.language",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.language"
},
{
"id": "DocumentReference.content.attachment.data",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.data"
},
{
"id": "DocumentReference.content.attachment.url",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.url"
},
{
"id": "DocumentReference.content.attachment.size",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.size"
},
{
"id": "DocumentReference.content.attachment.hash",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.hash"
},
{
"id": "DocumentReference.content.attachment.title",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.content.attachment.title"
},
{
"id": "DocumentReference.context",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context",
"min": 1
},
{
"id": "DocumentReference.context.related",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/service-request"
]
}
]
},
{
"id": "DocumentReference.context.related.reference",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.reference"
},
{
"id": "DocumentReference.context.related.identifier",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier"
},
{
"id": "DocumentReference.context.related.identifier.use",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier.use",
"min": 1
},
{
"id": "DocumentReference.context.related.identifier.system",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier.system",
"min": 1
},
{
"id": "DocumentReference.context.related.identifier.value",
"extension": [
{
"extension": [
{
"url": "name",
"valueString": "pcare"
},
{
"url": "code",
"valueCode": "SHALL:populate"
},
{
"url": "code",
"valueCode": "SHALL:persist"
},
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "documentation",
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "DocumentReference.context.related.identifier.value",
"min": 1
}
]
}
}

Constraints

Obligations

ElementActorCode
authorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
authorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
authorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
authorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
authorhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
author.identifierhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
author.identifier.systemhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
author.identifier.valuehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
author.referencehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
author.referencehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
author.referencehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
author.referencehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
author.referencehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
contenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
contenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
contenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
contenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
contenthttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachmenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
content.attachmenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
content.attachmenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
content.attachmenthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
content.attachmenthttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachment.contentTypehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachment.datahttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachment.hashhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachment.languagehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachment.sizehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachment.titlehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
content.attachment.urlhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
contexthttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
context.relatedhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
context.related.identifierhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
context.related.identifier.systemhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
context.related.identifier.usehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
context.related.identifier.valuehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
context.related.referencehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
datehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
datehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
datehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
datehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
datehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
identifierhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
identifierhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
identifierhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
identifierhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
identifierhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
identifier.systemhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
identifier.systemhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
identifier.systemhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
identifier.systemhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
identifier.systemhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
identifier.valuehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
identifier.valuehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
identifier.valuehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
identifier.valuehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
identifier.valuehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
metahttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
meta.profilehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
statushttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
subjecthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
subjecthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
subjecthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
subjecthttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
subjecthttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
subject.identifierhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
subject.identifier.systemhttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
subject.identifier.valuehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
subject.referencehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error
typehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
typehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumerSHALL:no-error
typehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
typehttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producerSHALL:populate-if-known
typehttp://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-serverSHALL:populate, SHALL:persist, SHALL:no-error

Terminology bindings (Differential)

Terminology bindings (Snapshot)

PathConformanceValueSet
DocumentReference.meta.securityextensiblehttp://hl7.org/fhir/ValueSet/security-labels|4.0.1
DocumentReference.meta.tagexamplehttp://hl7.org/fhir/ValueSet/common-tags|4.0.1
DocumentReference.languagepreferredhttp://hl7.org/fhir/ValueSet/languages
DocumentReference.identifier.userequiredhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
DocumentReference.identifier.typeextensiblehttp://hl7.org/fhir/ValueSet/identifier-type
DocumentReference.statusrequiredhttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
DocumentReference.docStatusrequiredhttp://hl7.org/fhir/ValueSet/composition-status|4.0.1
DocumentReference.typepreferredhttp://hl7.org/fhir/ValueSet/c80-doc-typecodes
DocumentReference.categoryexamplehttp://hl7.org/fhir/ValueSet/document-classcodes
DocumentReference.subject.typeextensiblehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
DocumentReference.subject.identifier.userequiredhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
DocumentReference.subject.identifier.typeextensiblehttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
DocumentReference.author.typeextensiblehttp://hl7.org/fhir/ValueSet/resource-types
DocumentReference.author.identifier.userequiredhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
DocumentReference.author.identifier.typeextensiblehttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
DocumentReference.relatesTo.coderequiredhttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
DocumentReference.securityLabelextensiblehttp://hl7.org/fhir/ValueSet/security-labels
DocumentReference.content.attachment.contentTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1
DocumentReference.content.attachment.languagepreferredhttp://hl7.org/fhir/ValueSet/languages|4.0.1
DocumentReference.content.formatpreferredhttp://hl7.org/fhir/ValueSet/formatcodes
DocumentReference.context.eventexamplehttp://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0
DocumentReference.context.facilityTypeexamplehttp://hl7.org/fhir/ValueSet/c80-facilitycodes
DocumentReference.context.practiceSettingexamplehttp://hl7.org/fhir/ValueSet/c80-practice-codes
DocumentReference.context.related.typeextensiblehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1
DocumentReference.context.related.identifier.userequiredhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
DocumentReference.context.related.identifier.typeextensiblehttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1

Additional Terminology Bindings Only

IG © based on FHIR R4 | template version 2.5.1 | Package package:ca.infoway.io.pcare@0.1.0-dft-preballot
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