0.1.0 - ci-build

eReferralMustSupport - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: CAeReCDocumentReference

Official URL: http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCDocumentReference | Version: 0.1.0
Draft as of 2024-08-15 | Computable Name: CAeReCDocumentReference

A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.

Usage:

- Refer to this Resource Profile: CAeReCServiceRequest

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from DocumentReference

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
DocumentReference |  |  | DocumentReference |
identifier | S | 0..* | Identifier | Other identifiers for the document
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
status | S | 1..1 | code | current | superseded | entered-in-error Required Pattern: current
type | S | 0..1 | CodeableConcept | Kind of document (LOINC if possible)
subject | S | 0..1 | Reference(CAeReCPatient) | Who/what is the subject of the document
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
date | S | 0..1 | instant | When this document reference was created
author | S | 0..* | Reference(CAeReCPractitioner | CAeReCPractitionerRole) | Who and/or what authored the document
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
content | S | 1..* | BackboneElement | Document referenced
attachment | S | 1..1 | Attachment | Where to access the document
context |  |  |  |
related | S | 0..* | Reference(CAeReCServiceRequest) | Related identifiers or resources
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
DocumentReference |  | 0..* | DocumentReference | A reference to a document
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Other identifiers for the document
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
status | ?!S Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
type | S Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
subject | S Σ | 0..1 | Reference(CAeReCPatient) | Who/what is the subject of the document
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
date | S Σ | 0..1 | instant | When this document reference was created
author | S Σ | 0..* | Reference(CAeReCPractitioner | CAeReCPractitionerRole) | Who and/or what authored the document
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
content | S Σ | 1..* | BackboneElement | Document referenced
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
attachment | S Σ | 1..1 | Attachment | Where to access the document
context | Σ | 0..1 | BackboneElement | Clinical context of document
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
related | S | 0..* | Reference(CAeReCServiceRequest) | Related identifiers or resources
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
DocumentReference.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.status | required | Pattern: current `http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1` from the FHIR Standard
DocumentReference.type | preferred | DocumentTypeValueSet `http://hl7.org/fhir/ValueSet/c80-doc-typecodes` from the FHIR Standard
DocumentReference.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.context.related.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | DocumentReference | 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-4 | error | DocumentReference | 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
DocumentReference |  | 0..* | DocumentReference | A reference to a document
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier
identifier | S Σ | 0..* | Identifier | Other identifiers for the document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
status | ?!S Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type | S Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
subject | S Σ | 0..1 | Reference(CAeReCPatient) | Who/what is the subject of the document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
date | S Σ | 0..1 | instant | When this document reference was created
author | S Σ | 0..* | Reference(CAeReCPractitioner | CAeReCPractitionerRole) | Who and/or what authored the document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
authenticator |  | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document
custodian |  | 0..1 | Reference(Organization) | Organization which maintains the document
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship
description | Σ | 0..1 | string | Human-readable description
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content | S Σ | 1..* | BackboneElement | Document referenced
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
attachment | S Σ | 1..1 | Attachment | Where to access the document
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
context | Σ | 0..1 | BackboneElement | Clinical context of document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
encounter |  | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content
event |  | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period | Σ | 0..1 | Period | Time of service that is being documented
facilityType |  | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting |  | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo |  | 0..1 | Reference(Patient) | Patient demographics from source
related | S | 0..* | Reference(CAeReCServiceRequest) | Related identifiers or resources
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
DocumentReference.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
DocumentReference.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
DocumentReference.status | required | Pattern: current `http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1` from the FHIR Standard
DocumentReference.docStatus | required | CompositionStatus `http://hl7.org/fhir/ValueSet/composition-status|4.0.1` from the FHIR Standard
DocumentReference.type | preferred | DocumentTypeValueSet `http://hl7.org/fhir/ValueSet/c80-doc-typecodes` from the FHIR Standard
DocumentReference.category | example | DocumentClassValueSet `http://hl7.org/fhir/ValueSet/document-classcodes` from the FHIR Standard
DocumentReference.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
DocumentReference.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.subject.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
DocumentReference.author.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
DocumentReference.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.author.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
DocumentReference.relatesTo.code | required | DocumentRelationshipType `http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1` from the FHIR Standard
DocumentReference.securityLabel | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from `http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem`) `http://hl7.org/fhir/ValueSet/formatcodes` from the FHIR Standard
DocumentReference.context.event | example | ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSet `http://hl7.org/fhir/ValueSet/c80-facilitycodes` from the FHIR Standard
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
DocumentReference.context.related.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
DocumentReference.context.related.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.context.related.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | DocumentReference | 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-4 | error | DocumentReference | 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from DocumentReference

Summary

Mandatory: 0 element(8 nested mandatory elements)
Must-Support: 23 elements

Structures

This structure refers to these other structures:

- CAeReCPatient (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPatient)
- CAeReCPractitioner (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitioner)
- CAeReCPractitionerRole (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitionerRole)
- CAeReCServiceRequest (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCServiceRequest)

Differential View

This structure is derived from DocumentReference

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
DocumentReference |  |  | DocumentReference |
identifier | S | 0..* | Identifier | Other identifiers for the document
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
status | S | 1..1 | code | current | superseded | entered-in-error Required Pattern: current
type | S | 0..1 | CodeableConcept | Kind of document (LOINC if possible)
subject | S | 0..1 | Reference(CAeReCPatient) | Who/what is the subject of the document
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
date | S | 0..1 | instant | When this document reference was created
author | S | 0..* | Reference(CAeReCPractitioner | CAeReCPractitionerRole) | Who and/or what authored the document
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
content | S | 1..* | BackboneElement | Document referenced
attachment | S | 1..1 | Attachment | Where to access the document
context |  |  |  |
related | S | 0..* | Reference(CAeReCServiceRequest) | Related identifiers or resources
reference | S | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S | 0..1 | Identifier | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
DocumentReference |  | 0..* | DocumentReference | A reference to a document
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 0..* | Identifier | Other identifiers for the document
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
status | ?!S Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
type | S Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
subject | S Σ | 0..1 | Reference(CAeReCPatient) | Who/what is the subject of the document
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
date | S Σ | 0..1 | instant | When this document reference was created
author | S Σ | 0..* | Reference(CAeReCPractitioner | CAeReCPractitionerRole) | Who and/or what authored the document
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
content | S Σ | 1..* | BackboneElement | Document referenced
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
attachment | S Σ | 1..1 | Attachment | Where to access the document
context | Σ | 0..1 | BackboneElement | Clinical context of document
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
related | S | 0..* | Reference(CAeReCServiceRequest) | Related identifiers or resources
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
DocumentReference.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.status | required | Pattern: current `http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1` from the FHIR Standard
DocumentReference.type | preferred | DocumentTypeValueSet `http://hl7.org/fhir/ValueSet/c80-doc-typecodes` from the FHIR Standard
DocumentReference.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.context.related.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | DocumentReference | 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-4 | error | DocumentReference | 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
DocumentReference |  | 0..* | DocumentReference | A reference to a document
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier
identifier | S Σ | 0..* | Identifier | Other identifiers for the document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
status | ?!S Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. Required Pattern: current
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type | S Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
subject | S Σ | 0..1 | Reference(CAeReCPatient) | Who/what is the subject of the document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
date | S Σ | 0..1 | instant | When this document reference was created
author | S Σ | 0..* | Reference(CAeReCPractitioner | CAeReCPractitionerRole) | Who and/or what authored the document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
authenticator |  | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document
custodian |  | 0..1 | Reference(Organization) | Organization which maintains the document
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship
description | Σ | 0..1 | string | Human-readable description
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content | S Σ | 1..* | BackboneElement | Document referenced
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
attachment | S Σ | 1..1 | Attachment | Where to access the document
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
context | Σ | 0..1 | BackboneElement | Clinical context of document
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
encounter |  | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content
event |  | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period | Σ | 0..1 | Period | Time of service that is being documented
facilityType |  | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting |  | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo |  | 0..1 | Reference(Patient) | Patient demographics from source
related | S | 0..* | Reference(CAeReCServiceRequest) | Related identifiers or resources
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | S Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
display | Σ | 0..1 | string | Text alternative for the resource
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
DocumentReference.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
`http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
DocumentReference.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
DocumentReference.status | required | Pattern: current `http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1` from the FHIR Standard
DocumentReference.docStatus | required | CompositionStatus `http://hl7.org/fhir/ValueSet/composition-status|4.0.1` from the FHIR Standard
DocumentReference.type | preferred | DocumentTypeValueSet `http://hl7.org/fhir/ValueSet/c80-doc-typecodes` from the FHIR Standard
DocumentReference.category | example | DocumentClassValueSet `http://hl7.org/fhir/ValueSet/document-classcodes` from the FHIR Standard
DocumentReference.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
DocumentReference.subject.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.subject.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
DocumentReference.author.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
DocumentReference.author.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.author.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
DocumentReference.relatesTo.code | required | DocumentRelationshipType `http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1` from the FHIR Standard
DocumentReference.securityLabel | extensible | All Security Labels `http://hl7.org/fhir/ValueSet/security-labels` from the FHIR Standard
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from `http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem`) `http://hl7.org/fhir/ValueSet/formatcodes` from the FHIR Standard
DocumentReference.context.event | example | ActCode `http://terminology.hl7.org/ValueSet/v3-ActCode`
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSet `http://hl7.org/fhir/ValueSet/c80-facilitycodes` from the FHIR Standard
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
DocumentReference.context.related.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
DocumentReference.context.related.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
DocumentReference.context.related.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | DocumentReference | 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-4 | error | DocumentReference | 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from DocumentReference

Summary

Mandatory: 0 element(8 nested mandatory elements)
Must-Support: 23 elements

Structures

This structure refers to these other structures:

- CAeReCPatient (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPatient)
- CAeReCPractitioner (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitioner)
- CAeReCPractitionerRole (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCPractitionerRole)
- CAeReCServiceRequest (http://hl7.ca/fhir/eReferral/StructureDefinition/CAeReCServiceRequest)

Other representations of profile: CSV, Excel, Schematron