Athena Core Implementation Guide
4.5.0 - release

Athena Core Implementation Guide - Local Development build (v4.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: athenahealth DocumentReference

Official URL: https://fhir.athena.io/StructureDefinition/ah-documentreference Version: 4.5.0
Active as of 2025-05-09 Computable Name: AthenahealthDocumentReference
Keywords: Wire Format

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed.

A DocumentReference resource is used to index a document, clinical note, and other binary objects to make them available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g., what subject, author, etc. can be displayed to the user), and has defined update management.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta
.... lastUpdated 0..1 instant When the resource version last changed
.... security 0..* Coding Security Labels applied to this resource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahPublishedDateTimeToPortal 0..1 dateTime athenahealth Published Date Time To Portal
URL: https://fhir.athena.io/StructureDefinition/ah-published-date-time-to-portal
... masterIdentifier 0..0
... author 0..* Reference(Practitioner | Organization) Who and/or what authored the document
... authenticator 0..0
... relatesTo 0..0
... description 0..0
... securityLabel 0..0
... context
.... encounter 0..* Reference(Encounter) Context of the document content
.... event 0..0
.... facilityType 0..0
.... practiceSetting 0..0
.... sourcePatientInfo 0..0
.... related 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPublishedDateTimeToPortal 0..1 dateTime athenahealth Published Date Time To Portal
URL: https://fhir.athena.io/StructureDefinition/ah-published-date-time-to-portal
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... subject Σ 0..1 Reference(Patient) Who/what is the subject of the document
ele-1: All FHIR elements must have a @value or children
... author Σ 0..* Reference(Practitioner | Organization) Who and/or what authored the document
ele-1: All FHIR elements must have a @value or children
... content Σ 1..* BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahPublishedDateTimeToPortal 0..1 dateTime athenahealth Published Date Time To Portal
URL: https://fhir.athena.io/StructureDefinition/ah-published-date-time-to-portal
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.

... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ 0..1 Reference(Patient) Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | Organization) Who and/or what authored the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.

... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter) Context of the document content
.... period Σ 0..1 Period Time of service that is being documented

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... meta
.... lastUpdated 0..1 instant When the resource version last changed
.... security 0..* Coding Security Labels applied to this resource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahPublishedDateTimeToPortal 0..1 dateTime athenahealth Published Date Time To Portal
URL: https://fhir.athena.io/StructureDefinition/ah-published-date-time-to-portal
... masterIdentifier 0..0
... author 0..* Reference(Practitioner | Organization) Who and/or what authored the document
... authenticator 0..0
... relatesTo 0..0
... description 0..0
... securityLabel 0..0
... context
.... encounter 0..* Reference(Encounter) Context of the document content
.... event 0..0
.... facilityType 0..0
.... practiceSetting 0..0
.... sourcePatientInfo 0..0
.... related 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:ahPublishedDateTimeToPortal 0..1 dateTime athenahealth Published Date Time To Portal
URL: https://fhir.athena.io/StructureDefinition/ah-published-date-time-to-portal
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... subject Σ 0..1 Reference(Patient) Who/what is the subject of the document
ele-1: All FHIR elements must have a @value or children
... author Σ 0..* Reference(Practitioner | Organization) Who and/or what authored the document
ele-1: All FHIR elements must have a @value or children
... content Σ 1..* BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ahChartSharingGroup 0..1 Reference(Organization) athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
.... extension:ahPractice 1..1 Reference(Organization) athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
.... extension:ahPublishedDateTimeToPortal 0..1 dateTime athenahealth Published Date Time To Portal
URL: https://fhir.athena.io/StructureDefinition/ah-published-date-time-to-portal
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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.

... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

... category Σ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ 0..1 Reference(Patient) Who/what is the subject of the document
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | Organization) Who and/or what authored the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.

... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter) Context of the document content
.... period Σ 0..1 Period Time of service that is being documented

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
DocumentReference.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard

This structure is derived from DocumentReference

 

​Other representations of profile: CSV, Excel, Schematron