Left: | AU Core DocumentReference (http://hl7.org.au/fhir/core/StructureDefinition/au-core-documentreference) |
Right: | AU Core DocumentReference (http://hl7.org.au/fhir/core/StructureDefinition/au-core-documentreference) |
Error | StructureDefinition.version | Values for version differ: '0.2.1-preview' vs '0.2.2-preview' |
Information | StructureDefinition.date | Values for date differ: '2023-08-22T20:24:06+10:00' vs '2023-11-16T10:32:02+11:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/DocumentReference | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. | ||
date | 2023-08-22T20:24:06+10:00 | 2023-11-16T10:32:02+11:00 |
|
description | This profile sets minimum expectations for a DocumentReference resource to record, search, and fetch patient documents. It is based on the core FHIR [DocumentReference](http://hl7.org/fhir/R4/documentreference.html) resource and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the DocumentReference resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#AU | ||
kind | resource | ||
name | AUCoreDocumentReference | ||
publisher | HL7 Australia | ||
purpose | |||
status | draft | ||
title | AU Core DocumentReference | ||
type | DocumentReference | ||
url | http://hl7.org.au/fhir/core/StructureDefinition/au-core-documentreference | ||
version | 0.2.1-preview | 0.2.2-preview |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | 0..* | DocumentReference | A reference to a document | |||||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | |||||||||
identifier | SΣ | 1..* | Identifier | Other identifiers for the document | SΣ | 1..* | Identifier | Other identifiers for the document | |||||||||
status | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. | |||||||||
docStatus | SΣ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required): Status of the underlying document. | SΣ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required): Status of the underlying document. | |||||||||
type | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. | |||||||||
category | SΣ | 1..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. | SΣ | 1..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. | |||||||||
subject | SΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document | SΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document | |||||||||
date | SΣ | 1..1 | instant | When this document reference was created | SΣ | 1..1 | instant | When this document reference was created | |||||||||
author | 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Σ | 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 | |||||||||
authenticator | S | 0..1 | Reference(AU Core PractitionerRole | AU Core Organization) | Who/what authenticated the document | S | 0..1 | Reference(AU Core PractitionerRole | AU Core Organization) | Who/what authenticated the document | |||||||||
custodian | S | 0..1 | Reference(AU Core Organization) | Organization which maintains the document | S | 0..1 | Reference(AU Core Organization) | Organization which maintains the document | |||||||||
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | Σ | 0..* | BackboneElement | Relationships to other documents | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: ?? (required): The type of relationship between documents. | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: ?? (required): The type of relationship between documents. | |||||||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | |||||||||
description | SΣ | 0..1 | string | Human-readable description | SΣ | 0..1 | string | Human-readable description | |||||||||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||
content | SΣ | 1..* | BackboneElement | Document referenced | SΣ | 1..* | BackboneElement | Document referenced | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
attachment | SΣ | 1..1 | Attachment | Where to access the document | SΣ | 1..1 | Attachment | Where to access the document | |||||||||
format | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. | |||||||||
context | SΣ | 0..1 | BackboneElement | Clinical context of document | SΣ | 0..1 | BackboneElement | Clinical context of document | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
encounter | S | 0..* | Reference(AU Core Encounter) | Context of the document content | S | 0..* | Reference(AU Core Encounter) | Context of the document content | |||||||||
event | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. | |||||||||||
period | Σ | 0..1 | Period | Time of service that is being documented | Σ | 0..1 | Period | Time of service that is being documented | |||||||||
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. | |||||||||||
practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). | |||||||||||
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | 0..1 | Reference(Patient) | Patient demographics from source | |||||||||||
related | 0..* | Reference(Resource) | Related identifiers or resources | 0..* | Reference(Resource) | Related identifiers or resources | |||||||||||
Documentation for this format |