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

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

Resource Profile: Profile_R5_DocumentReference_R3

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_R3

This cross-version profile allows R5 DocumentReference content to be represented via FHIR STU3 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 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
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.
... indexed Σ 1..1 instant When this document reference was created
... relatesTo ?!Σ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType . (required): The type of relationship between documents.
..... 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: R5DocumentRelationshipTypeForR3 (0.1.0) (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... content Σ 1..* BackboneElement Document referenced
.... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 📍3.0.2 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍20091109 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType . 📍3.0.2 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-1 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference 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: R5CompositionStatusForR3 (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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] 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..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
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: R5DocumentRelationshipTypeForR3 (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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] 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 STU3(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR STU3(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 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
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 | appended | 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
..... 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: R5CompositionStatusForR3 (0.1.0) (required): Status of the underlying document.
.... value 0..1 code Primitive value for code
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.
... class Σ 0..1 CodeableConcept Categorization of document
Binding: Document Class Value Set (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 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... created Σ 0..1 dateTime Document creation time
... indexed Σ 1..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... 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 | Organization) Who/what authenticated the document
... custodian Σ 0..1 Reference(Organization) Organization which maintains the document
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo ?!Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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
...... 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: R5DocumentRelationshipTypeForR3 (0.1.0) (extensible): The type of relationship between the documents.
..... value 0..1 code Primitive value for code
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... 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 (title)
... 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 xml:id (or equivalent in JSON)
.... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... attachment Σ 1..1 Attachment Where to access the document
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReference Format Code Set (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string xml:id (or equivalent in JSON)
.... 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 STU3(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR STU3(0.1.0) | EpisodeOfCare) R5: Context of the document content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.context
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... encounter Σ 0..1 Reference(Encounter) Context of the document content
.... event Σ 0..* CodeableConcept ​Main clinical acts documented
Binding: ActCode|2016-11-11 (example): This list of codes represents the main clinical acts being documented.
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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
..... 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: Facility Type Code Value Set (example): XDS Facility Type.
.... practiceSetting Σ 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo Σ 0..1 Reference(Patient) Patient demographics from source
.... related Σ 0..* BackboneElement Related identifiers or resources
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... identifier Σ 0..1 Identifier Identifier of related objects or events
..... ref Σ 0..1 Reference(Resource) Related Resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
DocumentReference.status Base required DocumentReferenceStatus 📍3.0.2 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus . 📍3.0.2 tx.fhir.org
DocumentReference.type Base preferred Document Type Value Set 📍20091109 FHIR Std.
DocumentReference.class Base example Document Class Value Set 📍20091109 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType . 📍3.0.2 tx.fhir.org
DocumentReference.securityLabel Base extensible All Security Labels . 📍3.0.2 tx.fhir.org
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍20150326 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode . 📍2016-11-11 tx.fhir.org
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍20091109 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍20091109 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference 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
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.
... indexed Σ 1..1 instant When this document reference was created
... relatesTo ?!Σ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType . (required): The type of relationship between documents.
..... 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: R5DocumentRelationshipTypeForR3 (0.1.0) (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... content Σ 1..* BackboneElement Document referenced
.... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 📍3.0.2 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📍20091109 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType . 📍3.0.2 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-1 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions 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 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: R5CompositionStatusForR3 (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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] 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..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
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: R5DocumentRelationshipTypeForR3 (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 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] 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 STU3(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR STU3(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 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
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 | appended | 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
..... 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: R5CompositionStatusForR3 (0.1.0) (required): Status of the underlying document.
.... value 0..1 code Primitive value for code
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.
... class Σ 0..1 CodeableConcept Categorization of document
Binding: Document Class Value Set (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 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Who/what is the subject of the document additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... created Σ 0..1 dateTime Document creation time
... indexed Σ 1..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... 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 | Organization) Who/what authenticated the document
... custodian Σ 0..1 Reference(Organization) Organization which maintains the document
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo ?!Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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
...... 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: R5DocumentRelationshipTypeForR3 (0.1.0) (extensible): The type of relationship between the documents.
..... value 0..1 code Primitive value for code
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:target 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: target additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... 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 (title)
... 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 xml:id (or equivalent in JSON)
.... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... attachment Σ 1..1 Attachment Where to access the document
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReference Format Code Set (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string xml:id (or equivalent in JSON)
.... 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 STU3(0.1.0) | Appointment | Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter | Cross-version Profile for R5.EpisodeOfCare for use in FHIR STU3(0.1.0) | EpisodeOfCare) R5: Context of the document content additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.context
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... encounter Σ 0..1 Reference(Encounter) Context of the document content
.... event Σ 0..* CodeableConcept ​Main clinical acts documented
Binding: ActCode|2016-11-11 (example): This list of codes represents the main clinical acts being documented.
..... id 0..1 string xml:id (or equivalent in JSON)
..... 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
..... 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: Facility Type Code Value Set (example): XDS Facility Type.
.... practiceSetting Σ 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).
.... sourcePatientInfo Σ 0..1 Reference(Patient) Patient demographics from source
.... related Σ 0..* BackboneElement Related identifiers or resources
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... identifier Σ 0..1 Identifier Identifier of related objects or events
..... ref Σ 0..1 Reference(Resource) Related Resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
DocumentReference.status Base required DocumentReferenceStatus 📍3.0.2 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus . 📍3.0.2 tx.fhir.org
DocumentReference.type Base preferred Document Type Value Set 📍20091109 FHIR Std.
DocumentReference.class Base example Document Class Value Set 📍20091109 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType . 📍3.0.2 tx.fhir.org
DocumentReference.securityLabel Base extensible All Security Labels . 📍3.0.2 tx.fhir.org
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍20150326 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode . 📍2016-11-11 tx.fhir.org
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍20091109 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍20091109 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron