abstractbaseDefinitioncopyrightdescription- Values Differ
experimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurl| Left: | AU eRequesting Clinical Context DocumentReference (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-clinicalcontext-documentreference) |
| Right: | AU eRequesting Clinical Context DocumentReference (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-clinicalcontext-documentreference) |
| Information | DocumentReference.language | Example/preferred bindings differ at DocumentReference.language using binding from AUeRequestingClinicalContextDocumentReference |
| Warning | DocumentReference.type | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Information | DocumentReference.type | Element minimum cardinalities differ: '0' vs '1' |
| Information | DocumentReference.type | Example/preferred bindings differ at DocumentReference.type using binding from AUeRequestingClinicalContextDocumentReference |
| Information | DocumentReference.content.attachment.language | Example/preferred bindings differ at DocumentReference.content.attachment.language using binding from AUeRequestingClinicalContextDocumentReference |
| Information | DocumentReference.content.format | Example/preferred bindings differ at DocumentReference.content.format using binding from AUeRequestingClinicalContextDocumentReference |
| 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© 2024+; Licensed Under Creative Commons No Rights Reserved. | ||
| description | This profile sets minimum expectations for representing Clinical Context using a DocumentReference resource to record, search, and fetch clinical context narrative information that provides an overview of the individual's current clinical situation assocated with a requested service. Clinical context is intended to describe the broader clinical background or circumstances relating to the request, supporting the service provider in making informed decisions about service delivery. It is based on the [DocumentReference](https://hl7.org/fhir/R4/documentreference.html) and identifies the additional constraints, extensions, vocabularies and value sets that **SHALL** be present in the DocumentReference when conforming to this profile. | This profile sets minimum expectations for representing clinical context using a DocumentReference resource to record, search, and fetch clinical context narrative information that provides an overview of the individual's current clinical situation associated with a requested service. Clinical context is intended to describe the broader clinical background or circumstances relating to the request, supporting the service provider in making informed decisions about service delivery. It is based on the [DocumentReference](https://hl7.org/fhir/R4/documentreference.html) resource and identifies the additional constraints, extensions, vocabularies and value sets that **SHALL** be present in the DocumentReference when conforming to this profile. |
|
| experimental | |||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#AU | ||
| kind | resource | ||
| name | AUeRequestingClinicalContextDocumentReference | ||
| publisher | HL7 Australia | ||
| purpose | |||
| status | active | ||
| title | AU eRequesting Clinical Context DocumentReference | ||
| type | DocumentReference | ||
| url | http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-clinicalcontext-documentreference | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 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 | 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 | Σ | 0..* | Identifier | Other identifiers for the document | Σ | 0..* | Identifier | Other identifiers for the document | |||||||||||||||||||||||||
| status | ?!SOΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference.
| ?!SOΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference.
| |||||||||||||||||||||||||
| docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required): Status of the underlying document. | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required): Status of the underlying document. | |||||||||||||||||||||||||
| type | Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. | SOΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. Required Pattern: {"coding":[{"system":"http://loinc.org","code":"107903-7"}]}
|
| ||||||||||||||||||||||||
| category | Σ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. | Σ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. | |||||||||||||||||||||||||
| subject | SOΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document
| SOΣ | 1..1 | Reference(AU Core Patient) | Who/what is the subject of the document
| |||||||||||||||||||||||||
| date | Σ | 0..1 | instant | When this document reference was created | Σ | 0..1 | instant | When this document reference was created | |||||||||||||||||||||||||
| author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | |||||||||||||||||||||||||
| authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||||||||||||||||||||||||
| custodian | 0..1 | Reference(Organization) | Organization which maintains the document | 0..1 | Reference(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 | Σ | 0..1 | string | Human-readable description | Σ | 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 | SOΣ | 1..* | BackboneElement | Document referenced
| SOΣ | 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 | SOΣ | 1..1 | Attachment | Where to access the document
| SOΣ | 1..1 | Attachment | Where to access the document
| |||||||||||||||||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
| contentType | SOΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/plain
| SOΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. Fixed Value: text/plain
| |||||||||||||||||||||||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Example General: en-AU | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Example General: en-AU |
| ||||||||||||||||||||||||
| data | SO | 1..1 | base64Binary | Data inline, base64ed
| SO | 1..1 | base64Binary | Data inline, base64ed
| |||||||||||||||||||||||||
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | |||||||||||||||||||||||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||||||||||||||||||||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | Σ | 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 | Σ | 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 | Σ | 0..1 | dateTime | Date attachment was first created | |||||||||||||||||||||||||
| format | Σ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. | Σ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. |
| ||||||||||||||||||||||||
 context | Σ | 0..1 | BackboneElement | Clinical context of document | Σ | 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 | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | 0..* | Reference(Encounter | EpisodeOfCare) | 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 | |||||||||||||||||||||||||||||||||