This page is part of the Da Vinci Prior Authorization Support (PAS) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-documentreference
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | I | 0..* | A reference to a document | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
masterIdentifier | SΣ | 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) |
docStatus | Σ | 0..1 | code | preliminary | final | appended | amended | entered-in-error Binding: CompositionStatus (required) |
type | Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred) |
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example) |
subject | Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document |
date | Σ | 0..1 | instant | When this document reference was created |
author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |
custodian | 0..1 | Reference(Organization) | Organization which maintains the document | |
relatesTo | ΣI | 0..* | BackboneElement | Relationships to other documents |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
description | SΣ | 0..1 | string | Human-readable description |
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible) |
content | SΣI | 1..* | BackboneElement | Document referenced |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-reportTransmission | SI | 0..* | code | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-reportTransmission |
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) |
context | ΣI | 0..1 | BackboneElement | Clinical context of document |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
encounter | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |
event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example) | |
period | Σ | 0..1 | Period | Time of service that is being documented |
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example) | |
practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example) | |
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |
related | 0..* | Reference(Resource) | Related identifiers or resources | |
Documentation for this format |
This structure is derived from DocumentReference
Differential View
This structure is derived from DocumentReference
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | I | 0..* | A reference to a document | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
masterIdentifier | SΣ | 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) |
docStatus | Σ | 0..1 | code | preliminary | final | appended | amended | entered-in-error Binding: CompositionStatus (required) |
type | Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred) |
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example) |
subject | Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document |
date | Σ | 0..1 | instant | When this document reference was created |
author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |
custodian | 0..1 | Reference(Organization) | Organization which maintains the document | |
relatesTo | ΣI | 0..* | BackboneElement | Relationships to other documents |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
description | SΣ | 0..1 | string | Human-readable description |
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible) |
content | SΣI | 1..* | BackboneElement | Document referenced |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension-reportTransmission | SI | 0..* | code | Extension URL: http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-reportTransmission |
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) |
context | ΣI | 0..1 | BackboneElement | Clinical context of document |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
encounter | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |
event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example) | |
period | Σ | 0..1 | Period | Time of service that is being documented |
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example) | |
practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example) | |
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |
related | 0..* | Reference(Resource) | Related identifiers or resources | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
DocumentReference.language | preferred | CommonLanguages Max Binding: AllLanguages |
DocumentReference.status | required | DocumentReferenceStatus |
DocumentReference.docStatus | required | CompositionStatus |
DocumentReference.type | preferred | DocumentTypeValueSet |
DocumentReference.category | example | DocumentClassValueSet |
DocumentReference.relatesTo.code | required | DocumentRelationshipType |
DocumentReference.securityLabel | extensible | All Security Labels |
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet |
DocumentReference.context.event | example | v3.ActCode |
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSet |
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSet |
Id | Path | Details | Requirements |
dom-2 | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-6 | DocumentReference | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
ele-1 | DocumentReference.relatesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentReference.content | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | DocumentReference.content.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DocumentReference.content.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DocumentReference.content.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | DocumentReference.content.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | DocumentReference.context | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |