Da Vinci Prior Authorization Support (PAS) FHIR IG
2.2.1 - STU 2.2 United States of America flag

Da Vinci Prior Authorization Support (PAS) FHIR IG, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pas/ and changes regularly. See the Directory of published versions

Resource Profile: PAS Document Reference

Official URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-documentreference Version: 2.2.1
Standards status: Trial-use Maturity Level: 4 Computable Name: PASDocumentReference
Other Identifiers: OID:2.16.840.1.113883.4.642.40.24.42.81

PAS constraints on US Core DocumentReference to require the document content to be included and not referenced externally.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* USCoreDocumentReferenceProfile(7.0.0) A reference to a document
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.identifier This element must be supported. This element is included in summaries. 0..* Identifier Other identifiers for the document
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
DocumentReference.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: USCoreDocumentReferenceType (7.0.0) (required): All LOINC values whose SCALE is "Doc" in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
Additional BindingsPurpose
USCoreClinicalNoteType (7.0.0) Min Binding
DocumentReference.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Categorization of document
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for category.category:uscore This element is included in summaries. 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Categorization of document
Binding: USCoreDocumentReferenceCategory (7.0.0) (required): The US Core DocumentReferences Type Value Set is a "starter set" of categories supported for fetching and storing clinical notes. Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) This type must be supported. | Practitioner | Group | Device) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0) | Device) Who and/or what authored the document
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment Where to access the document
Constraints: us-core-6
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.data This element must be supported. C 1..1 base64Binary Data inline, base64ed
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: HL7FormatCodes (2.1.0) (extensible)
DocumentReference.context This element must be supported. This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter This element must be supported. 0..1 Reference(US Core Encounter Profile(7.0.0)) Context of the document content
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📦4.0.1 FHIR Std.
DocumentReference.type Base required US Core DocumentReference Type 📍7.0.0 US Core v7.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category:uscore Base required US Core DocumentReference Category 📍7.0.0 US Core v7.0
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base extensible HL7 ValueSet of Format Codes for use with Document Sharing 📍2.1.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreDocumentReferenceProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* USCoreDocumentReferenceProfile(7.0.0) A reference to a document
DocumentReference.content
DocumentReference.content.attachment
DocumentReference.content.attachment.data 1..1 base64Binary Data inline, base64ed
DocumentReference.content.attachment.url 0..0 Uri where the data can be found

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* USCoreDocumentReferenceProfile(7.0.0) A reference to a document
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.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
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.extension 0..* Extension Additional content defined by implementations
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.masterIdentifier This element is included in summaries. 0..1 Identifier Master Version Specific Identifier
DocumentReference.identifier This element must be supported. This element is included in summaries. 0..* Identifier Other identifiers for the document
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
DocumentReference.docStatus This element is included in summaries. 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: USCoreDocumentReferenceType (7.0.0) (required): All LOINC values whose SCALE is "Doc" in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
Additional BindingsPurpose
USCoreClinicalNoteType (7.0.0) Min Binding
DocumentReference.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Categorization of document
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for category.category:uscore This element is included in summaries. 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Categorization of document
Binding: USCoreDocumentReferenceCategory (7.0.0) (required): The US Core DocumentReferences Type Value Set is a "starter set" of categories supported for fetching and storing clinical notes. Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) This type must be supported. | Practitioner | Group | Device) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0) | Device) Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document
DocumentReference.relatesTo This element is included in summaries. 0..* BackboneElement Relationships to other documents
DocumentReference.relatesTo.id 0..1 string Unique id for inter-element referencing
DocumentReference.relatesTo.extension 0..* Extension Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.extension 0..* Extension Additional content defined by implementations
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment Where to access the document
Constraints: us-core-6
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.language This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
DocumentReference.content.attachment.data This element must be supported. C 1..1 base64Binary Data inline, base64ed
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: HL7FormatCodes (2.1.0) (extensible)
DocumentReference.context This element must be supported. This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter This element must be supported. 0..1 Reference(US Core Encounter Profile(7.0.0)) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.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).
DocumentReference.context.sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
DocumentReference.context.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.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📦4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base required US Core DocumentReference Type 📍7.0.0 US Core v7.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category:uscore Base required US Core DocumentReference Category 📍7.0.0 US Core v7.0
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base extensible HL7 ValueSet of Format Codes for use with Document Sharing 📍2.1.0 THO v7.4
DocumentReference.context.​event Base example v3 Code System ActCode 📍3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreDocumentReferenceProfile

Summary

Mandatory: 1 element
Prohibited: 1 element

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* USCoreDocumentReferenceProfile(7.0.0) A reference to a document
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.identifier This element must be supported. This element is included in summaries. 0..* Identifier Other identifiers for the document
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
DocumentReference.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: USCoreDocumentReferenceType (7.0.0) (required): All LOINC values whose SCALE is "Doc" in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
Additional BindingsPurpose
USCoreClinicalNoteType (7.0.0) Min Binding
DocumentReference.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Categorization of document
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for category.category:uscore This element is included in summaries. 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Categorization of document
Binding: USCoreDocumentReferenceCategory (7.0.0) (required): The US Core DocumentReferences Type Value Set is a "starter set" of categories supported for fetching and storing clinical notes. Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) This type must be supported. | Practitioner | Group | Device) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0) | Device) Who and/or what authored the document
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment Where to access the document
Constraints: us-core-6
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.data This element must be supported. C 1..1 base64Binary Data inline, base64ed
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: HL7FormatCodes (2.1.0) (extensible)
DocumentReference.context This element must be supported. This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter This element must be supported. 0..1 Reference(US Core Encounter Profile(7.0.0)) Context of the document content
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📦4.0.1 FHIR Std.
DocumentReference.type Base required US Core DocumentReference Type 📍7.0.0 US Core v7.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category:uscore Base required US Core DocumentReference Category 📍7.0.0 US Core v7.0
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base extensible HL7 ValueSet of Format Codes for use with Document Sharing 📍2.1.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from USCoreDocumentReferenceProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* USCoreDocumentReferenceProfile(7.0.0) A reference to a document
DocumentReference.content
DocumentReference.content.attachment
DocumentReference.content.attachment.data 1..1 base64Binary Data inline, base64ed
DocumentReference.content.attachment.url 0..0 Uri where the data can be found

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* USCoreDocumentReferenceProfile(7.0.0) A reference to a document
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.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
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.extension 0..* Extension Additional content defined by implementations
DocumentReference.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
DocumentReference.masterIdentifier This element is included in summaries. 0..1 Identifier Master Version Specific Identifier
DocumentReference.identifier This element must be supported. This element is included in summaries. 0..* Identifier Other identifiers for the document
DocumentReference.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required)
DocumentReference.docStatus This element is included in summaries. 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
DocumentReference.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: USCoreDocumentReferenceType (7.0.0) (required): All LOINC values whose SCALE is "Doc" in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
Additional BindingsPurpose
USCoreClinicalNoteType (7.0.0) Min Binding
DocumentReference.Slices for category This element must be supported. This element is included in summaries. 1..* CodeableConcept Categorization of document
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for category.category:uscore This element is included in summaries. 0..* CodeableConcept 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Categorization of document
Binding: USCoreDocumentReferenceCategory (7.0.0) (required): The US Core DocumentReferences Type Value Set is a "starter set" of categories supported for fetching and storing clinical notes. Note that other codes are permitted, see Required Bindings When Slicing by Value Sets
DocumentReference.subject This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile(7.0.0) This type must be supported. | Practitioner | Group | Device) Who/what is the subject of the document
DocumentReference.date This element must be supported. This element is included in summaries. 0..1 instant When this document reference was created
DocumentReference.author This element must be supported. This element is included in summaries. 0..* Reference(US Core Practitioner Profile(7.0.0) This type must be supported. | US Core Organization Profile(7.0.0) | US Core Patient Profile(7.0.0) | US Core PractitionerRole Profile(7.0.0) | US Core RelatedPerson Profile(7.0.0) | Device) Who and/or what authored the document
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document
DocumentReference.relatesTo This element is included in summaries. 0..* BackboneElement Relationships to other documents
DocumentReference.relatesTo.id 0..1 string Unique id for inter-element referencing
DocumentReference.relatesTo.extension 0..* Extension Additional content defined by implementations
DocumentReference.relatesTo.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.relatesTo.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content This element must be supported. This element is included in summaries. 1..* BackboneElement Document referenced
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.extension 0..* Extension Additional content defined by implementations
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element must be supported. This element is included in summaries. C 1..1 Attachment Where to access the document
Constraints: us-core-6
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element must be supported. This element is included in summaries. 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
DocumentReference.content.attachment.language This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
DocumentReference.content.attachment.data This element must be supported. C 1..1 base64Binary Data inline, base64ed
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element is included in summaries. 0..1 dateTime Date attachment was first created
DocumentReference.content.format This element must be supported. This element is included in summaries. 0..1 Coding Format/content rules for the document
Binding: HL7FormatCodes (2.1.0) (extensible)
DocumentReference.context This element must be supported. This element is included in summaries. 0..1 BackboneElement Clinical context of document
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter This element must be supported. 0..1 Reference(US Core Encounter Profile(7.0.0)) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element must be supported. This element is included in summaries. 0..1 Period Time of service that is being documented
DocumentReference.context.facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
DocumentReference.context.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).
DocumentReference.context.sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
DocumentReference.context.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.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📦4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base required US Core DocumentReference Type 📍7.0.0 US Core v7.0
DocumentReference.category Base example Document Class Value Set 📦4.0.1 FHIR Std.
DocumentReference.category:uscore Base required US Core DocumentReference Category 📍7.0.0 US Core v7.0
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📦4.0.1 FHIR Std.
DocumentReference.content.​format Base extensible HL7 ValueSet of Format Codes for use with Document Sharing 📍2.1.0 THO v7.4
DocumentReference.context.​event Base example v3 Code System ActCode 📍3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📦4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from USCoreDocumentReferenceProfile

Summary

Mandatory: 1 element
Prohibited: 1 element

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron