Helix AU Core
0.1.0 - ci-build
Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://medicaldirector.com/fhir/helix-au-core/StructureDefinition/HelixAUCoreDocumentReference | Version: 0.1.0 | |||
| Draft as of 2025-08-12 | Computable Name: HelixAUCoreDocumentReference | |||
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..* | AUCoreDocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SΣ | 1..1 | HelixBaseAuthoringKey | Other identifiers for the document |
![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() |
SΣ | 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: DocumentTypeValueSet (preferred): Precise type of clinical document. |
![]() ![]() |
SΣ | 1..* | CodeableConcept | The Document Category outlines the different categories that can be assigned to a document. Contains a subset of the 'Record artefact foundation reference set' <https://healthterminologies.gov.au/fhir/ValueSet/sctau-reference-set-32570161000036106>. Binding: Document Category (preferred) |
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document |
![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created |
![]() ![]() |
SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core Organization | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the document |
![]() ![]() |
S | 0..1 | Reference(AU Core PractitionerRole | AU Core Organization) | Who/what authenticated the document |
![]() ![]() |
S | 0..1 | Reference(AU Core Organization) | Organization which maintains the document |
![]() ![]() |
SΣ | 0..1 | string | Human-readable description |
![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. |
![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..* | Reference(AU Core Encounter) | Context of the document content |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1From the FHIR Standard | |
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | |
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesFrom the FHIR Standard | |
| DocumentReference.category | preferred | HelixAUCoreDocumentCategoryhttp://fhir.medicaldirector.com/fhir/helix-base/ValueSet/document-categoryFrom this IG | |
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesFrom 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() |
This structure is derived from AUCoreDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCoreDocumentReference | A reference to a document | |
![]() ![]() |
1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | |
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | Other identifiers for the document |
![]() ![]() |
1..* | CodeableConcept | The Document Category outlines the different categories that can be assigned to a document. Contains a subset of the 'Record artefact foundation reference set' <https://healthterminologies.gov.au/fhir/ValueSet/sctau-reference-set-32570161000036106>. Binding: Document Category (preferred) | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.category | preferred | HelixAUCoreDocumentCategoryhttp://fhir.medicaldirector.com/fhir/helix-base/ValueSet/document-categoryFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUCoreDocumentReference | 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 | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SΣ | 1..1 | HelixBaseAuthoringKey | Other identifiers for the document | ||||
![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() |
SΣ | 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: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The Document Category outlines the different categories that can be assigned to a document. Contains a subset of the 'Record artefact foundation reference set' <https://healthterminologies.gov.au/fhir/ValueSet/sctau-reference-set-32570161000036106>. Binding: Document Category (preferred) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document | ||||
![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created | ||||
![]() ![]() |
SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core Organization | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() |
S | 0..1 | Reference(AU Core PractitionerRole | AU Core Organization) | Who/what authenticated the document | ||||
![]() ![]() |
S | 0..1 | Reference(AU Core 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Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
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(AU Core Encounter) | 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. | |||||
![]() ![]() ![]() |
Σ | 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 | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1From the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | ||||
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesFrom the FHIR Standard | ||||
| DocumentReference.category | preferred | HelixAUCoreDocumentCategoryhttp://fhir.medicaldirector.com/fhir/helix-base/ValueSet/document-categoryFrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesFrom the FHIR Standard | ||||
| DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesFrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesFrom 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() |
This structure is derived from AUCoreDocumentReference
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCoreDocumentReference | A reference to a document | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() |
SΣ | 1..1 | HelixBaseAuthoringKey | Other identifiers for the document |
![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() |
SΣ | 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: DocumentTypeValueSet (preferred): Precise type of clinical document. |
![]() ![]() |
SΣ | 1..* | CodeableConcept | The Document Category outlines the different categories that can be assigned to a document. Contains a subset of the 'Record artefact foundation reference set' <https://healthterminologies.gov.au/fhir/ValueSet/sctau-reference-set-32570161000036106>. Binding: Document Category (preferred) |
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document |
![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created |
![]() ![]() |
SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core Organization | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the document |
![]() ![]() |
S | 0..1 | Reference(AU Core PractitionerRole | AU Core Organization) | Who/what authenticated the document |
![]() ![]() |
S | 0..1 | Reference(AU Core Organization) | Organization which maintains the document |
![]() ![]() |
SΣ | 0..1 | string | Human-readable description |
![]() ![]() |
SΣ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. |
![]() ![]() |
SΣ | 0..1 | BackboneElement | Clinical context of document |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..* | Reference(AU Core Encounter) | Context of the document content |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1From the FHIR Standard | |
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | |
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesFrom the FHIR Standard | |
| DocumentReference.category | preferred | HelixAUCoreDocumentCategoryhttp://fhir.medicaldirector.com/fhir/helix-base/ValueSet/document-categoryFrom this IG | |
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesFrom 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() |
Differential View
This structure is derived from AUCoreDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AUCoreDocumentReference | A reference to a document | |
![]() ![]() |
1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | |
![]() ![]() ![]() |
S | 1..1 | HelixBaseAuthoringKey | Other identifiers for the document |
![]() ![]() |
1..* | CodeableConcept | The Document Category outlines the different categories that can be assigned to a document. Contains a subset of the 'Record artefact foundation reference set' <https://healthterminologies.gov.au/fhir/ValueSet/sctau-reference-set-32570161000036106>. Binding: Document Category (preferred) | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.category | preferred | HelixAUCoreDocumentCategoryhttp://fhir.medicaldirector.com/fhir/helix-base/ValueSet/document-categoryFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | AUCoreDocumentReference | 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 | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() |
SΣ | 1..1 | HelixBaseAuthoringKey | Other identifiers for the document | ||||
![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() |
SΣ | 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: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The Document Category outlines the different categories that can be assigned to a document. Contains a subset of the 'Record artefact foundation reference set' <https://healthterminologies.gov.au/fhir/ValueSet/sctau-reference-set-32570161000036106>. Binding: Document Category (preferred) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document | ||||
![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created | ||||
![]() ![]() |
SΣ | 1..* | Reference(AU Core PractitionerRole | AU Core Organization | AU Core System Device | AU Core Patient | AU Core RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() |
S | 0..1 | Reference(AU Core PractitionerRole | AU Core Organization) | Who/what authenticated the document | ||||
![]() ![]() |
S | 0..1 | Reference(AU Core 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Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() |
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(AU Core Encounter) | 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. | |||||
![]() ![]() ![]() |
Σ | 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 | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1From the FHIR Standard | ||||
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | ||||
| DocumentReference.type | preferred | DocumentTypeValueSethttp://hl7.org/fhir/ValueSet/c80-doc-typecodesFrom the FHIR Standard | ||||
| DocumentReference.category | preferred | HelixAUCoreDocumentCategoryhttp://fhir.medicaldirector.com/fhir/helix-base/ValueSet/document-categoryFrom this IG | ||||
| DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)http://hl7.org/fhir/ValueSet/formatcodesFrom the FHIR Standard | ||||
| DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
| DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesFrom the FHIR Standard | ||||
| DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesFrom 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() |
This structure is derived from AUCoreDocumentReference
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron