Extensions for Using Data Elements from FHIR R5 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_DocumentReference_R4B

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-DocumentReference Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_DocumentReference_R4B

This cross-version profile allows R5 DocumentReference content to be represented via FHIR R4B DocumentReference resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.3.0) A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..* BackboneElement Document referenced
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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 DocumentReference.implicitRules, DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.status, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension, DocumentReference.content.attachment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.3.0) A reference to a document
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
... docStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:docStatus 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: R5CompositionStatusForR4B (0.1.0) (required): Status of the underlying document.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Resource) R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relatesTo
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 CodeableConcept R5: The relationship type with another document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.relatesTo.code
Binding: R5DocumentRelationshipTypeForR4B (0.1.0) (extensible): The type of relationship between the documents.
.... target
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 Reference(Resource) R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
... context
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..* Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR R4B(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR R4B(0.1.0) | EpisodeOfCare) R5: Context of the document content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.context
.... event
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:event 0..* Reference() R5: event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.event

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.3.0) 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:docStatus 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: R5CompositionStatusForR4B (0.1.0) (required): Status of the underlying document.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (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 Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference Σ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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:author 0..1 Reference(Resource) R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference Σ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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:code 0..1 CodeableConcept R5: The relationship type with another document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.relatesTo.code
Binding: R5DocumentRelationshipTypeForR4B (0.1.0) (extensible): The type of relationship between the documents.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:target 0..1 Reference(Resource) R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference Σ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)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... 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 Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..* Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR R4B(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR R4B(0.1.0) | EpisodeOfCare) R5: Context of the document content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.context
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:event 0..* Reference() R5: event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.event
Constraints: ext-1
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.3.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.3.0 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.3.0 FHIR Std.
DocumentReference.type Base preferred FHIR Document Type Codes 📍4.3.0 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.3.0 FHIR Std.
DocumentReference.subject.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
DocumentReference.author.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.3.0 FHIR Std.
DocumentReference.relatesTo.​target.type Base extensible ResourceType 📍4.3.0 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.3.0 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.3.0 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📍3.0.0 THO v7.1
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.3.0 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning DocumentReference.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error DocumentReference.meta, DocumentReference.implicitRules, DocumentReference.language, DocumentReference.text, DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.masterIdentifier, DocumentReference.identifier, DocumentReference.status, DocumentReference.docStatus, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.type, DocumentReference.category, DocumentReference.subject, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.subject.reference, DocumentReference.subject.type, DocumentReference.subject.identifier, DocumentReference.subject.display, DocumentReference.date, DocumentReference.author, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.author.reference, DocumentReference.author.type, DocumentReference.author.identifier, DocumentReference.author.display, DocumentReference.authenticator, DocumentReference.custodian, DocumentReference.relatesTo, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code, DocumentReference.relatesTo.code.extension, DocumentReference.relatesTo.code.extension:code, DocumentReference.relatesTo.target, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.relatesTo.target.reference, DocumentReference.relatesTo.target.type, DocumentReference.relatesTo.target.identifier, DocumentReference.relatesTo.target.display, DocumentReference.description, DocumentReference.securityLabel, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.format, DocumentReference.context, DocumentReference.context.extension, DocumentReference.context.extension:context, DocumentReference.context.modifierExtension, DocumentReference.context.encounter, DocumentReference.context.event, DocumentReference.context.event.extension, DocumentReference.context.event.extension:event, DocumentReference.context.event.coding, DocumentReference.context.event.text, DocumentReference.context.period, DocumentReference.context.facilityType, DocumentReference.context.practiceSetting, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code.extension, DocumentReference.relatesTo.code.extension:code, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension, DocumentReference.context.extension, DocumentReference.context.extension:context, DocumentReference.context.modifierExtension, DocumentReference.context.event.extension, DocumentReference.context.event.extension:event Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.3.0) A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... content Σ 1..* BackboneElement Document referenced
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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 DocumentReference.implicitRules, DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.status, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension, DocumentReference.content.attachment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.3.0) A reference to a document
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
... docStatus
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:docStatus 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: R5CompositionStatusForR4B (0.1.0) (required): Status of the underlying document.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Resource) R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relatesTo
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 CodeableConcept R5: The relationship type with another document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.relatesTo.code
Binding: R5DocumentRelationshipTypeForR4B (0.1.0) (extensible): The type of relationship between the documents.
.... target
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 Reference(Resource) R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... content
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
... context
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..* Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR R4B(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR R4B(0.1.0) | EpisodeOfCare) R5: Context of the document content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.context
.... event
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:event 0..* Reference() R5: event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.event

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(4.3.0) 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the DocumentReference (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
Constraints: ext-1
.... extension:attester 0..* (Complex) R5: Attests to accuracy of the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.attester
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other identifiers for the document
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:docStatus 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.docStatus
Binding: R5CompositionStatusForR4B (0.1.0) (required): Status of the underlying document.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (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 Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference Σ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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:author 0..1 Reference(Resource) R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference Σ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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:code 0..1 CodeableConcept R5: The relationship type with another document additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.relatesTo.code
Binding: R5DocumentRelationshipTypeForR4B (0.1.0) (extensible): The type of relationship between the documents.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:target 0..1 Reference(Resource) R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference Σ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)
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... 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 Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:profile 0..* (Complex) R5: Content profile rules for the document (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..* Reference(Cross-version Profile for R5.Appointment for use in FHIR R4B(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR R4B(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR R4B(0.1.0) | EpisodeOfCare) R5: Context of the document content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.context
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:event 0..* Reference() R5: event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.event
Constraints: ext-1
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.3.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.3.0 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.3.0 FHIR Std.
DocumentReference.type Base preferred FHIR Document Type Codes 📍4.3.0 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.3.0 FHIR Std.
DocumentReference.subject.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
DocumentReference.author.​type Base extensible ResourceType 📍4.3.0 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.3.0 FHIR Std.
DocumentReference.relatesTo.​target.type Base extensible ResourceType 📍4.3.0 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.3.0 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.3.0 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📍3.0.0 THO v7.1
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.3.0 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning DocumentReference.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error DocumentReference.meta, DocumentReference.implicitRules, DocumentReference.language, DocumentReference.text, DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.masterIdentifier, DocumentReference.identifier, DocumentReference.status, DocumentReference.docStatus, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.type, DocumentReference.category, DocumentReference.subject, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.subject.reference, DocumentReference.subject.type, DocumentReference.subject.identifier, DocumentReference.subject.display, DocumentReference.date, DocumentReference.author, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.author.reference, DocumentReference.author.type, DocumentReference.author.identifier, DocumentReference.author.display, DocumentReference.authenticator, DocumentReference.custodian, DocumentReference.relatesTo, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code, DocumentReference.relatesTo.code.extension, DocumentReference.relatesTo.code.extension:code, DocumentReference.relatesTo.target, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.relatesTo.target.reference, DocumentReference.relatesTo.target.type, DocumentReference.relatesTo.target.identifier, DocumentReference.relatesTo.target.display, DocumentReference.description, DocumentReference.securityLabel, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.format, DocumentReference.context, DocumentReference.context.extension, DocumentReference.context.extension:context, DocumentReference.context.modifierExtension, DocumentReference.context.encounter, DocumentReference.context.event, DocumentReference.context.event.extension, DocumentReference.context.event.extension:event, DocumentReference.context.event.coding, DocumentReference.context.event.text, DocumentReference.context.period, DocumentReference.context.facilityType, DocumentReference.context.practiceSetting, DocumentReference.context.sourcePatientInfo, DocumentReference.context.related All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:version, DocumentReference.extension:attester, DocumentReference.modifierExtension, DocumentReference.docStatus.extension, DocumentReference.docStatus.extension:docStatus, DocumentReference.subject.extension, DocumentReference.subject.extension:subject, DocumentReference.author.extension, DocumentReference.author.extension:author, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code.extension, DocumentReference.relatesTo.code.extension:code, DocumentReference.relatesTo.target.extension, DocumentReference.relatesTo.target.extension:target, DocumentReference.content.extension, DocumentReference.content.extension:profile, DocumentReference.content.modifierExtension, DocumentReference.context.extension, DocumentReference.context.extension:context, DocumentReference.context.modifierExtension, DocumentReference.context.event.extension, DocumentReference.context.event.extension:event Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron