This page is part of the PACIO Advance Directive Information Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-DocumentReference | Version: 2.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: ADIDocumentReference |
This profile defines constraints that represent the information needed to register an advance directive information document on a FHIR server.
Conformance:
Advance Directive Information versionNumber
represents a string value used to version successive replacement documents. Best practice for systems that support distributed document creation and updating is to populate the versionNumber with the timestamp created from the date/time when the version of the document is created in the system. Note: this may or may not be equivalent to the timestamp integer for Composition.date. the versionNumber timestamp always will be equivalent to the Bundle.timestamp for the document.
To better align with CDA, versionNumber
should be a string label generated by converting the ClinicalDocument.effectiveTime (or Composition.date) to UTC time (-0000) and then using the YYYYMMDDhhmmss as the version.
For documents created within a system will follow the pattern that the timestamp-label versionNumber will be equivalent to the timestamp of the Composition.date and the Bundle.timestamp. However, for unstructured historical documents uploaded into a system, the timestamp-label versionNumber will be equivalent to the timestamp of the timestamp of the system dateTime when the document was uploaded, but the Composition.date will reflect the creation date of the original document, if it is available. If the creation date of the original document is not known, then Composition.date may be the system dateTime when the document is uploaded.
This profile defines constraints that represent the information needed to register an advance directive information document on a FHIR server. Temporal information is essential to the document registration process. DocumentReference.date holds the date when the document was registered and DocumentReference.content.attachment.creation holds the "creation date" associated with the document itself.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreADIDocumentReferenceProfile | A reference to a document | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Authentication Time URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-authentication-time |
![]() ![]() ![]() ![]() |
S | 0..1 | code | Revoke Status URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-document-revoke-status Binding: ADI Document Revoke Status (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version Number URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-docVersionNumber-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) |
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ADI Composition Status (required) |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Healthcare Directive Document Types Grouper ![]() |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | CDA Document Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
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://terminology.hl7.org/CodeSystem/v3-HL7DocumentFormatCodes | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:hl7-org:sdwg:pacp-structuredBody:1.3 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: PACP Structured Body CDA Document |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | FHIR PACP Bundle Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
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: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Bundle | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: pacp-structuredBody:1.3 |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: USCoreDocumentReferenceCategory (8.0.0) (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of ADI document" Binding: Advance Healthcare Directive Categories LOINC ![]() |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile S) | Who/what is the subject of the document |
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created |
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core PractitionerRole Profile) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | Organization which maintains the document |
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: us-core-6 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
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Σ | 1..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: HL7FormatCodes (2.1.0) (extensible) |
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Encounter Profile) | Context of the document content |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | |
DocumentReference.docStatus | required | ADICompositionStatusVShttp://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS From this IG | |
DocumentReference.type | extensible | AdvanceHealthcareDirectiveDocumentTypesGrouper ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.41 | |
DocumentReference.category | extensible | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category|8.0.0 | |
DocumentReference.category:adi | required | AdvanceHealthcareDirectiveCategoriesLOINC ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4 | |
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
DocumentReference.content.format | extensible | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes|2.1.0 |
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 USCoreADIDocumentReferenceProfile
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
USCoreADIDocumentReferenceProfile | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | code | Revoke Status URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-document-revoke-status Binding: ADI Document Revoke Status (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version Number URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-docVersionNumber-extension |
![]() ![]() ![]() |
0..1 | code | preliminary | final | amended | entered-in-error Binding: ADI Composition Status (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | CDA Document Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-HL7DocumentFormatCodes | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:hl7-org:sdwg:pacp-structuredBody:1.3 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: PACP Structured Body CDA Document | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | FHIR PACP Bundle Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Bundle | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: pacp-structuredBody:1.3 | |
![]() ![]() ![]() |
1..* | CodeableConcept | Categorization of document Binding: USCoreDocumentReferenceCategory (8.0.0) (extensible) | |
![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile) | Who/what is the subject of the document | |
![]() ![]() ![]() |
1..1 | instant | When this document reference was created | |
![]() ![]() ![]() |
0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document | |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | Organization which maintains the document |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Encounter Profile) | Context of the document content |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time of service that is being documented |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.docStatus | required | ADICompositionStatusVShttp://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS From this IG | |
DocumentReference.category | extensible | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category|8.0.0 |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreADIDocumentReferenceProfile | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Authentication Time URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-authentication-time | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | Revoke Status URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-document-revoke-status Binding: ADI Document Revoke Status (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version Number URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-docVersionNumber-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ADI Composition Status (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Healthcare Directive Document Types Grouper ![]() | ||||
![]() ![]() ![]() ![]() |
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 Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | CDA Document Type Coding Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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://terminology.hl7.org/CodeSystem/v3-HL7DocumentFormatCodes | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:hl7-org:sdwg:pacp-structuredBody:1.3 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: PACP Structured Body CDA Document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | FHIR PACP Bundle Type Coding Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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: urn:ietf:rfc:3986 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Bundle | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: pacp-structuredBody:1.3 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: USCoreDocumentReferenceCategory (8.0.0) (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of ADI document" Binding: Advance Healthcare Directive Categories LOINC ![]() | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile S) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core PractitionerRole Profile) | Who/what authenticated the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | 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 | ||||
![]() ![]() ![]() |
Σ | 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 Constraints: us-core-6 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: HL7FormatCodes (2.1.0) (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..* | Reference(US Core Encounter Profile) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
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 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
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 | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.docStatus | required | ADICompositionStatusVShttp://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS From this IG | ||||
DocumentReference.type | extensible | AdvanceHealthcareDirectiveDocumentTypesGrouper ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.41 | ||||
DocumentReference.category | extensible | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category|8.0.0 | ||||
DocumentReference.category:adi | required | AdvanceHealthcareDirectiveCategoriesLOINC ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4 | ||||
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 | Mime Types(a valid code from urn:ietf:bcp:13 )http://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 | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes|2.1.0 | ||||
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 USCoreADIDocumentReferenceProfile
Summary
Mandatory: 3 elements(4 nested mandatory elements)
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreADIDocumentReferenceProfile | A reference to a document | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Authentication Time URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-authentication-time |
![]() ![]() ![]() ![]() |
S | 0..1 | code | Revoke Status URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-document-revoke-status Binding: ADI Document Revoke Status (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version Number URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-docVersionNumber-extension |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) |
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ADI Composition Status (required) |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Healthcare Directive Document Types Grouper ![]() |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | CDA Document Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
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://terminology.hl7.org/CodeSystem/v3-HL7DocumentFormatCodes | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:hl7-org:sdwg:pacp-structuredBody:1.3 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: PACP Structured Body CDA Document |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | FHIR PACP Bundle Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
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: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Bundle | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: pacp-structuredBody:1.3 |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: USCoreDocumentReferenceCategory (8.0.0) (extensible) |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of ADI document" Binding: Advance Healthcare Directive Categories LOINC ![]() |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile S) | Who/what is the subject of the document |
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created |
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core PractitionerRole Profile) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | Organization which maintains the document |
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: us-core-6 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
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Σ | 1..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: HL7FormatCodes (2.1.0) (extensible) |
![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Encounter Profile) | Context of the document content |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time of service that is being documented |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | |
DocumentReference.docStatus | required | ADICompositionStatusVShttp://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS From this IG | |
DocumentReference.type | extensible | AdvanceHealthcareDirectiveDocumentTypesGrouper ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.41 | |
DocumentReference.category | extensible | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category|8.0.0 | |
DocumentReference.category:adi | required | AdvanceHealthcareDirectiveCategoriesLOINC ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4 | |
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
DocumentReference.content.format | extensible | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes|2.1.0 |
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 USCoreADIDocumentReferenceProfile
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
USCoreADIDocumentReferenceProfile | |||
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | code | Revoke Status URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-document-revoke-status Binding: ADI Document Revoke Status (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version Number URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-docVersionNumber-extension |
![]() ![]() ![]() |
0..1 | code | preliminary | final | amended | entered-in-error Binding: ADI Composition Status (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | CDA Document Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-HL7DocumentFormatCodes | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:hl7-org:sdwg:pacp-structuredBody:1.3 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: PACP Structured Body CDA Document | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | FHIR PACP Bundle Type Coding Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: urn:ietf:rfc:3986 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Bundle | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Required Pattern: pacp-structuredBody:1.3 | |
![]() ![]() ![]() |
1..* | CodeableConcept | Categorization of document Binding: USCoreDocumentReferenceCategory (8.0.0) (extensible) | |
![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile) | Who/what is the subject of the document | |
![]() ![]() ![]() |
1..1 | instant | When this document reference was created | |
![]() ![]() ![]() |
0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document | |
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | Organization which maintains the document |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Date attachment was first created |
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(US Core Encounter Profile) | Context of the document content |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time of service that is being documented |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.docStatus | required | ADICompositionStatusVShttp://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS From this IG | |
DocumentReference.category | extensible | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category|8.0.0 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreADIDocumentReferenceProfile | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Authentication Time URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-authentication-time | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | Revoke Status URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-document-revoke-status Binding: ADI Document Revoke Status (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Version Number URL: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/adi-docVersionNumber-extension | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ADI Composition Status (required) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: Advance Healthcare Directive Document Types Grouper ![]() | ||||
![]() ![]() ![]() ![]() |
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 Slice: Unordered, Open by pattern:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | CDA Document Type Coding Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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://terminology.hl7.org/CodeSystem/v3-HL7DocumentFormatCodes | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: urn:hl7-org:sdwg:pacp-structuredBody:1.3 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: PACP Structured Body CDA Document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | FHIR PACP Bundle Type Coding Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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: urn:ietf:rfc:3986 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: http://hl7.org/fhir/us/pacio-adi/StructureDefinition/ADI-Bundle | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system Required Pattern: pacp-structuredBody:1.3 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: USCoreDocumentReferenceCategory (8.0.0) (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Categorization of ADI document" Binding: Advance Healthcare Directive Categories LOINC ![]() | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Patient Profile S) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(US Core PractitionerRole Profile | US Core Organization Profile | US Core Patient Profile) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core PractitionerRole Profile) | Who/what authenticated the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(US Core Organization Profile) | 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 | ||||
![]() ![]() ![]() |
Σ | 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 Constraints: us-core-6 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: HL7FormatCodes (2.1.0) (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..* | Reference(US Core Encounter Profile) | Context of the document content | ||||
![]() ![]() ![]() ![]() |
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 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
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 | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.docStatus | required | ADICompositionStatusVShttp://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS From this IG | ||||
DocumentReference.type | extensible | AdvanceHealthcareDirectiveDocumentTypesGrouper ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.41 | ||||
DocumentReference.category | extensible | USCoreDocumentReferenceCategoryhttp://hl7.org/fhir/us/core/ValueSet/us-core-documentreference-category|8.0.0 | ||||
DocumentReference.category:adi | required | AdvanceHealthcareDirectiveCategoriesLOINC ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4 | ||||
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 | Mime Types(a valid code from urn:ietf:bcp:13 )http://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 | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes|2.1.0 | ||||
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 USCoreADIDocumentReferenceProfile
Summary
Mandatory: 3 elements(4 nested mandatory elements)
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron