Kanta SOTE-yhteinen toimintakykyky, soveltamisopas_1.0.0

SocialWelfareDocumentReference

SocialWelfareDocumentReference -profiili on sosiaalihuollossa käytettävä DocumentReference-profiili, jolla Sosiaalihuollon asiakastietovaranto palauttaa merkinnän toimintakyvystä ja toimintakykyarvion haussa merkintään toimintakyvystä/toimintakykyarvioon liittyvien Sosiaalihuollon asiakastietovarantoon tallennettujen liiteasiakirjojen tiedot.

Profiilia ei käytetä toimintakykytietojen tallentamisessa.

SocialWelfareDocumentReference (DocumentReference)

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

Element id

DocumentReference

Short description

Liiteasiakirjan tiedot

Definition

Profiili, jolla Sosiaalihuollon asiakastietovaranto palauttaa merkinnän toimintakyvystä ja toimintakykyarvion haussa merkintään toimintakyvystä/toimintakykyarvioon liittyvien Sosiaalihuollon asiakastietovarantoon tallennettujen liiteasiakirjojen tiedot.

Profiilia ei käytetä toimintakykytietojen tallentamisessa.

Comments

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

Data type

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

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

0..1

string

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

string

Meta

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

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

language

0..1

codeBinding

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.

http://hl7.org/fhir/ValueSet/languages (preferred)

Binding extensions

http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet	http://hl7.org/fhir/ValueSet/all-languages

Conditions

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

Constraints

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

Mappings

rim: n/a

text

0..1

Narrative

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?

contained

0..*

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

extension

1..1

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

creationTime

1..1

Extension(dateTime)

Element id

DocumentReference.extension:creationTime

Short description

Liiteasiakirjan laatimisaika

Alternate names

extensions, user content

Definition

Sosiaalihuollon asiakastietovaranto palauttaa tiedossa liiteasiakirjan metatiedossa Asiakrjan laatimisaika (ClinicalDocument.effectiveTime) ilmoitetun laatimisajan.

Comments

Data type

Extension(dateTime)

Extension URL

https://shark.kanta.fi/fhir/StructureDefinition/extension/CreationTime

Conditions

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

Constraints

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

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

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

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

Identifier

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

identifier

1..1

Identifier

Element id

DocumentReference.identifier

Short description

Liiteasiakirjan yksilöintitunnus

Definition

Sosiaalihuollon asiakastietovaranto palauttaa tiedossa liiteasiakirjan metatiedossa Asiakirjan yksilöintitunnus (ClinicalDocument.id) ilmoitetun yksilöintitunnuksen.

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

0..1

string

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

extension

0..*

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

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

codeBinding

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 .

http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (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..1

CodeableConceptBinding

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.

http://hl7.org/fhir/ValueSet/identifier-type (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

system

1..1

uriFixed Value

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

Fixed value

urn:ietf:rfc:3986

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

value

1..1

string

Element id

DocumentReference.identifier.value

Short description

Liiteasiakirjan OID-tunnus

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

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

period

Σ C

0..1

Period

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

Σ C

0..1

Reference(http://hl7.org/fhir/StructureDefinition/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(http://hl7.org/fhir/StructureDefinition/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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

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

status

Σ ?!

1..1

codeBindingFixed Value

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.

http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 (required)

Conditions

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

Constraints

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

Fixed value

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

docStatus

0..0

codeBinding

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.

http://hl7.org/fhir/ValueSet/composition-status|4.0.1 (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

type

1..1

CodeableConceptBinding

Element id

DocumentReference.type

Short description

Liiteasiakirjan tarkennettu asiakirjatyyppi

Definition

Sosiaalihuollon asiakastietovaranto palauttaa tiedossa liiteasiakirjan metatiedossa Asiakirjan tarkennettu asiakirjatyyppi (ClinicalDocument.hl7fi:localSocialHeader.specificDocumentType) ilmoitetun tarkennetun asiakirjatyypin. Tarkennettu asiakirjatyyppi ilmoitetaan koodiston Sosiaalihuolto - Asiakasasiakirjatyyppi (1.2.246.537.6.1506.201701) alatason arvoilla.

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.

fishark-vs-documenttype (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: 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.

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.type.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

DocumentReference.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

coding

1..1

CodingBinding

Element id

DocumentReference.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Data type

Coding

Binding

fishark-vs-documenttype (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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.type.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

DocumentReference.type.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

1..1

uriFixed Value

Element id

DocumentReference.type.coding.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

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

Fixed value

urn:oid:1.2.246.537.6.1506.201701

Mappings

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

version

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.type.coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

code

Element id

DocumentReference.type.coding.code

Short description

Liiteasiakirjan tarkennetun asiakirjatyypin koodiarvo

Definition

Valuesetin Social Welfare Document Type mukainen liiteasiakirjan tarkennetun asiakirjatyypin koodiarvo.

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

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

Constraints

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

Mappings

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

display

1..1

string

Element id

DocumentReference.type.coding.display

Short description

Liiteasiakirjan tarkennetun asiakirjatyypin nimi

Definition

Valuesetin Social Welfare Document Type mukainen liiteasiakirjan tarkennetun asiakirjatyypin arvo. Arvon nimi vastaa annettua koodiarvoa.

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

DocumentReference.type.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

boolean

Conditions

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

Constraints

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

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.type.text

Short description

Plain text representation of the concept

Definition

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

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

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

Data type

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: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

category

1..1

CodeableConceptBinding

Element id

DocumentReference.category

Short description

Liiteasiakirjan yleinen asiakirjatyyppi

Alternate names

claxs

Definition

Sosiaalihuollon asiakastietovaranto palauttaa tiedossa liiteasiakirjan metatiedossa Yleinen asiakirjatyyppi (ClinicalDocument.Code) ilmoitetun yleisen asiakirjatyypin. Yleinen asiakirjatyyppi ilmoitetaan koodiston Sosiaalihuolto - Asiakasasiakirjatyyppi (1.2.246.537.6.1506.201701) ylätason arvoilla.

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.

fishark-vs-documenttype (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: 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

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.category.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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

DocumentReference.category.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

coding

1..1

CodingBinding

Element id

DocumentReference.category.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Coding

Binding

fishark-vs-documenttype (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: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.category.coding.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

DocumentReference.category.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

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

system

1..1

uriFixed Value

Element id

DocumentReference.category.coding.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

Data type

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

Fixed value

urn:oid:1.2.246.537.6.1506.201701

Mappings

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

version

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.category.coding.version

Short description

Version of the system - if relevant

Definition

Comments

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

code

Element id

DocumentReference.category.coding.code

Short description

Liiteasiakirjan yleisen asiakirjatyypin koodiarvo

Definition

Valuesetin Social Welfare Document Type mukainen yleisen asiakirjatyypin koodiarvo.

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

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

Constraints

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

Mappings

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

display

1..1

string

Element id

DocumentReference.category.coding.display

Short description

Yleisen asiakirjatyypin nimi

Definition

Valuesetin Social Welfare Document Type mukainen yleisen asiakirjatyypin arvo. Arvon nimi vastaa annettua koodiarvoa.

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

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: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

DocumentReference.category.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Conditions

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

Constraints

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

Mappings

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

text

0..1

string

There are no (further) constraints on this element

Element id

DocumentReference.category.text

Short description

Plain text representation of the concept

Definition

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

Requirements

Comments

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

Data type

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: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

subject

Σ C

0..0

Reference(http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/Group | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/Practitioner)

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

Conditions

The cardinality or value of this element may be 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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

date

0..0

instant

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"]

author

Σ C

0..0

Reference(http://hl7.org/fhir/StructureDefinition/Device | http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/PractitionerRole | http://hl7.org/fhir/StructureDefinition/RelatedPerson)

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

Conditions

The cardinality or value of this element may be 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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

authenticator

0..0

Reference(http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/PractitionerRole)

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(http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/PractitionerRole)

Conditions

The cardinality or value of this element may be 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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

custodian

0..0

Reference(http://hl7.org/fhir/StructureDefinition/Organization)

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(http://hl7.org/fhir/StructureDefinition/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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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

description

0..1

string

Element id

DocumentReference.description

Short description

Liiteasiakirjan kuvaus

Definition

Sosiaalihuollon asiakastietovarannon hakuvastauksessa palauttaman liiteasiakirjan kuvaus. Asiakastietovaranto palauttaa tiedossa liiteasiakirjan metatiedossa Asiakirjan kuvaus (ClinicalDocument.hl7fi:localSocialHeader.description) ilmoitetun kuvauksen.

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

http://hl7.org/fhir/ValueSet/security-labels (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

content

1..*

BackboneElement

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

0..1

string

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

extension

0..*

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

Comments

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

Σ ?! C

0..*

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

Comments

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

attachment

Σ C

1..1

Attachment

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

0..1

string

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

extension

0..*

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

Comments

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

contentType

1..1

codeBindingFixed Value

Element id

DocumentReference.content.attachment.contentType

Short description

CDA-asiakirjan tyyppi

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.

http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 (required)

Conditions

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

Constraints

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

Fixed value

text/xml

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

language

0..0

codeBinding

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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

A human language.

http://hl7.org/fhir/ValueSet/languages (preferred)

Binding extensions

http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet	http://hl7.org/fhir/ValueSet/all-languages

Conditions

The cardinality or value of this element may be 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

data

0..0

base64Binary

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

Conditions

The cardinality or value of this element may be 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

url

0..0

url

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

Conditions

The cardinality or value of this element may be 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

size

0..0

unsignedInt

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

Conditions

The cardinality or value of this element may be 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)

hash

0..0

base64Binary

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

Conditions

The cardinality or value of this element may be 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"]

title

0..0

string

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.

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

creation

1..1

dateTime

Element id

DocumentReference.content.attachment.creation

Short description

Liiteasiakirjan luontiaika

Definition

Sosiaalihuollon asiakastietovarannon hakuvastauksessa palauttaman liiteasiakirjan luontiaika. Asiakastietovaranto palauttaa tiedossa liiteasiakirjan metatiedossa Asiakirjan luontiaika (ClinicalDocument.effectiveTime) ilmoitetun luontiajan.

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

CodingBinding

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.

http://hl7.org/fhir/ValueSet/formatcodes (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

context

1..1

BackboneElement

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']

0..1

string

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

extension

0..*

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

Comments

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

Σ ?! C

0..*

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

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

Requirements

Comments

Data type

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

encounter

0..0

Reference(http://hl7.org/fhir/StructureDefinition/Encounter | http://hl7.org/fhir/StructureDefinition/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

Data type

Reference(http://hl7.org/fhir/StructureDefinition/Encounter | http://hl7.org/fhir/StructureDefinition/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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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

event

0..0

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.

http://terminology.hl7.org/ValueSet/v3-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

Σ C

0..0

Period

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

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

facilityType

0..0

CodeableConcept

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.

http://hl7.org/fhir/ValueSet/c80-facilitycodes (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

practiceSetting

0..0

CodeableConcept

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

http://hl7.org/fhir/ValueSet/c80-practice-codes (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

sourcePatientInfo

0..0

Reference(http://hl7.org/fhir/StructureDefinition/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

Data type

Reference(http://hl7.org/fhir/StructureDefinition/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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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/

1..1

Reference(http://hl7.org/fhir/StructureDefinition/Resource)

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(http://hl7.org/fhir/StructureDefinition/Resource)

Conditions

The cardinality or value of this element may be 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.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

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

0..1

string

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

extension

0..*

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

Comments

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

reference

Σ C

1..1

string

Element id

DocumentReference.context.related.reference

Short description

Viittaus Observation-resurssiin

Definition

Sosiaalihuollon asiakastietovaranto palauttaa tiedossa sen merkinnän toimintakyvystä/toimintakykyarvion Observation-resurssin yksilöivän tunnuksen (Observation.id), johon liiteasiakirja liittyy.

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

type

0..0

uriBinding

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

http://hl7.org/fhir/ValueSet/resource-types (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

identifier

0..0

Identifier

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

Conditions

The cardinality or value of this element may be 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

display

0..0

string

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