US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
Publication Build: This will be filled in by the publication tooling
Official URL: http://va.gov/fhir/StructureDefinition/DocumentReferenceDocumentReference | Version: 1.3.1 | |||
Active as of 2025-03-31 | Computable Name: DocumentReferenceDocumentReference |
This StructureDefinition contains the maps for VistA file TIU DOCUMENT (8925) to us-core-documentreference.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile(5.0.1) | A reference to a document This profile also complies with the profiles US Core DocumentReference Profile (6.1.0) and US Core DocumentReference Profile (7.0.0) 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 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?! | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://va.gov/identifiers/$Sta3n/8925 | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://loinc.org | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-note | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Practitioner) | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who/what authenticated the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organization which maintains the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable description ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document ele-1: All FHIR elements must have a @value or children us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 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. ele-1: All FHIR elements must have a @value or children Required Pattern: text/plain | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile(5.0.1)) | Context of the document content ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 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). ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources ele-1: All FHIR elements must have a @value or children | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status from the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.category:us-core | required | Pattern: clinical-notehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Pattern: text/plainhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from USCoreDocumentReferenceProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile(5.0.1) | A reference to a document This profile also complies with the profiles US Core DocumentReference Profile (6.1.0) and US Core DocumentReference Profile (7.0.0) | |
![]() ![]() ![]() |
0..1 | Identifier | Master Version Specific Identifier | |
![]() ![]() ![]() |
0..* | Identifier | Other identifiers for the document | |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/8925 |
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Categorization of document Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-note | |
![]() ![]() ![]() |
1..1 | Reference(Patient) | Who/what is the subject of the document | |
![]() ![]() ![]() |
0..1 | instant | When this document reference was created | |
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Who and/or what authored the document | |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() ![]() |
S | 0..1 | string | Human-readable description |
![]() ![]() ![]() |
0..* | CodeableConcept | Document security-tags | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: text/plain | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Uri where the data can be found | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Label to display in place of the data |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core Encounter Profile(5.0.1)) | Context of the document content | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Main clinical acts documented |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) |
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile(5.0.1) | A reference to a document This profile also complies with the profiles US Core DocumentReference Profile (6.1.0) and US Core DocumentReference Profile (7.0.0) | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/8925 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
| ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-note | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Practitioner) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who/what authenticated the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 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. Required Pattern: text/plain | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile(5.0.1)) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() ![]() |
S | 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). | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DocumentReference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status from the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.category:us-core | required | Pattern: clinical-notehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Pattern: text/plainhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from USCoreDocumentReferenceProfile
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile(5.0.1) | A reference to a document This profile also complies with the profiles US Core DocumentReference Profile (6.1.0) and US Core DocumentReference Profile (7.0.0) 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 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?! | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://va.gov/identifiers/$Sta3n/8925 | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://loinc.org | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-note | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Practitioner) | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who/what authenticated the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organization which maintains the document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable description ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document ele-1: All FHIR elements must have a @value or children us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 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. ele-1: All FHIR elements must have a @value or children Required Pattern: text/plain | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile(5.0.1)) | Context of the document content ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 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). ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources ele-1: All FHIR elements must have a @value or children | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status from the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.category:us-core | required | Pattern: clinical-notehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Pattern: text/plainhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
Differential View
This structure is derived from USCoreDocumentReferenceProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile(5.0.1) | A reference to a document This profile also complies with the profiles US Core DocumentReference Profile (6.1.0) and US Core DocumentReference Profile (7.0.0) | |
![]() ![]() ![]() |
0..1 | Identifier | Master Version Specific Identifier | |
![]() ![]() ![]() |
0..* | Identifier | Other identifiers for the document | |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/8925 |
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of document (LOINC if possible) | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Categorization of document Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-note | |
![]() ![]() ![]() |
1..1 | Reference(Patient) | Who/what is the subject of the document | |
![]() ![]() ![]() |
0..1 | instant | When this document reference was created | |
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Who and/or what authored the document | |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() ![]() |
S | 0..1 | string | Human-readable description |
![]() ![]() ![]() |
0..* | CodeableConcept | Document security-tags | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: text/plain | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | url | Uri where the data can be found | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Label to display in place of the data |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..1 | Reference(US Core Encounter Profile(5.0.1)) | Context of the document content | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Main clinical acts documented |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) |
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreDocumentReferenceProfile(5.0.1) | A reference to a document This profile also complies with the profiles US Core DocumentReference Profile (6.1.0) and US Core DocumentReference Profile (7.0.0) | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://va.gov/identifiers/$Sta3n/8925 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
| ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | Identity of the terminology system Required Pattern: http://loinc.org | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of document Binding: US Core DocumentReference Category (required): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: clinical-note | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Practitioner) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner) | Who/what authenticated the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 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. Required Pattern: text/plain | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (extensible) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(US Core Encounter Profile(5.0.1)) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() ![]() |
S | 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). | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentReference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
DocumentReference.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status from the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.type | required | USCoreDocumentReferenceTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-type
| ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.category:us-core | required | Pattern: clinical-notehttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Pattern: text/plainhttp://hl7.org/fhir/ValueSet/mimetypes|4.0.1 from the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentReference.content.format | extensible | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id 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-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
us-core-6 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from USCoreDocumentReferenceProfile
Other representations of profile: CSV, Excel, Schematron