Testing IG
0.0.1 - CI Build

Testing IG, published by DBojicic. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/dbojicic/test-repo/ and changes regularly. See the Directory of published versions

Resource Profile: EXPERIMENTAL AU Core DocumentReference Data ( Experimental )

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-documentreference-att-data Version: 0.0.1
Active as of 2026-10-02 Computable Name: AUCoreDocumentReferenceData

Test profile derived from AU Core DocumentReference exp profile and requires content.attachment.data is mandatory

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* AUCoreDocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier Other identifiers for the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... type SOΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred)
Additional BindingsPurpose
Common Document Types in Australia . candidate
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... category SOΣ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... subject SOΣ 1..1 Reference(AU Core Patient) Who/what is the subject of the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... date SOΣ 0..1 instant When this document reference was created
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... author SOΣ 0..* Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization | Device) Who and/or what authored the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... content SOΣ 1..* BackboneElement Document referenced
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SOΣC 1..1 Attachment Where to access the document
Constraints: au-core-docref-01
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... contentType SOΣ 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.
Example General: text/plain; charset=UTF-8, image/png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... data SO 1..1 base64Binary Data inline, base64ed
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... context SOΣ 0..1 BackboneElement Clinical context of document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SOΣ 0..1 Period Time of service that is being documented
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
au-core-docref-01 error DocumentReference.content.attachment At least url or data shall be present. url.exists() or data.exists()
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* AUCoreDocumentReference A reference to a document
... content
.... attachment
..... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* AUCoreDocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier SOΣ 0..* Identifier Other identifiers for the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... status ?!SOΣ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
... type SOΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred)
Additional BindingsPurpose
Common Document Types in Australia . candidate
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... category SOΣ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... subject SOΣ 1..1 Reference(AU Core Patient) Who/what is the subject of the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... date SOΣ 0..1 instant When this document reference was created
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... author SOΣ 0..* Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization | Device) Who and/or what authored the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SOΣ 1..* BackboneElement Document referenced
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SOΣC 1..1 Attachment Where to access the document
Constraints: au-core-docref-01
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SOΣ 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.
Example General: text/plain; charset=UTF-8, image/png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data SO 1..1 base64Binary Data inline, base64ed
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SOΣ 0..1 BackboneElement Clinical context of document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period SOΣ 0..1 Period Time of service that is being documented
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 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).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
au-core-docref-01 error DocumentReference.content.attachment At least url or data shall be present. url.exists() or data.exists()
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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* AUCoreDocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SOΣ 0..* Identifier Other identifiers for the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... type SOΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred)
Additional BindingsPurpose
Common Document Types in Australia . candidate
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... category SOΣ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... subject SOΣ 1..1 Reference(AU Core Patient) Who/what is the subject of the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... date SOΣ 0..1 instant When this document reference was created
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... author SOΣ 0..* Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization | Device) Who and/or what authored the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... content SOΣ 1..* BackboneElement Document referenced
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SOΣC 1..1 Attachment Where to access the document
Constraints: au-core-docref-01
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... contentType SOΣ 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.
Example General: text/plain; charset=UTF-8, image/png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... data SO 1..1 base64Binary Data inline, base64ed
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... context SOΣ 0..1 BackboneElement Clinical context of document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period SOΣ 0..1 Period Time of service that is being documented
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
au-core-docref-01 error DocumentReference.content.attachment At least url or data shall be present. url.exists() or data.exists()
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* AUCoreDocumentReference A reference to a document
... content
.... attachment
..... data 1..1 base64Binary Data inline, base64ed

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* AUCoreDocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
... identifier SOΣ 0..* Identifier Other identifiers for the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... status ?!SOΣ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.
... type SOΣ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred)
Additional BindingsPurpose
Common Document Types in Australia . candidate
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... category SOΣ 0..* CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... subject SOΣ 1..1 Reference(AU Core Patient) Who/what is the subject of the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... date SOΣ 0..1 instant When this document reference was created
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... author SOΣ 0..* Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Patient | AU Core RelatedPerson | AU Core Organization | Device) Who and/or what authored the document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content SOΣ 1..* BackboneElement Document referenced
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment SOΣC 1..1 Attachment Where to access the document
Constraints: au-core-docref-01
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SOΣ 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.
Example General: text/plain; charset=UTF-8, image/png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data SO 1..1 base64Binary Data inline, base64ed
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... url SOΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context SOΣ 0..1 BackboneElement Clinical context of document
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period SOΣ 0..1 Period Time of service that is being documented
ObligationsActorSource
SHALL:populate-if-known AU Core Responder from EXPERIMENTAL AU Core DocumentReference
SHALL:no-error AU Core Requester from EXPERIMENTAL AU Core DocumentReference
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 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).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
au-core-docref-01 error DocumentReference.content.attachment At least url or data shall be present. url.exists() or data.exists()
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

 

Other representations of profile: CSV, Excel, Schematron