DocumentReference
Resource name | Canonical (defining) URL | Simplifier link |
---|---|---|
DocumentReference | https://standards.medicalert.nz/ns/MaDocumentReference | https://simplifier.net/nz-hira/medicalertdocumentreference/ |
This is a profile on the DocumentReference resource. It is used to link resources (such as Advance Directives) to a copy of the original document (usually in PDF format), that a resource is based on.
Note: Currently data will not be populated in the following fields, but this information may become available in the future so the cardinality has been left as 0..1/*:
- masterIdentifier
- docStatus
- date (may be in future)
- author
- authenticator
- custodian
- relatesTo
- description
- securityLabel
- context
Differential View
DocumentReference | I | DocumentReference | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
masterIdentifier | Σ | 0..1 | Identifier |
identifier | Σ | 0..* | Identifier |
status | Σ ?! | 1..1 | codeBinding |
docStatus | Σ | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
category | Σ | 0..* | CodeableConcept |
subject | Σ I | 0..1 | Reference(Patient | Practitioner | Group | Device) |
date | Σ | 0..1 | instant |
author | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) |
authenticator | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
custodian | I | 0..1 | Reference(Organization) |
relatesTo | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | codeBinding |
target | Σ I | 1..1 | Reference(DocumentReference) |
description | Σ | 0..1 | string |
securityLabel | Σ | 0..* | CodeableConceptBinding |
content | Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
attachment | Σ I | 1..1 | Attachment |
format | Σ | 0..1 | CodingBinding |
context | Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
encounter | I | 0..* | Reference(Encounter | EpisodeOfCare) |
event | 0..* | CodeableConcept | |
period | Σ I | 0..1 | Period |
facilityType | 0..1 | CodeableConcept | |
practiceSetting | 0..1 | CodeableConcept | |
sourcePatientInfo | I | 0..1 | Reference(Patient) |
related | I | 0..* | Reference(Resource) |
Hybrid View
DocumentReference | I | DocumentReference | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
masterIdentifier | Σ | 0..1 | Identifier |
identifier | Σ | 0..* | Identifier |
status | Σ ?! | 1..1 | codeBinding |
docStatus | Σ | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
category | Σ | 0..* | CodeableConcept |
subject | Σ I | 0..1 | Reference(Patient | Practitioner | Group | Device) |
date | Σ | 0..1 | instant |
author | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) |
authenticator | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
custodian | I | 0..1 | Reference(Organization) |
relatesTo | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | codeBinding |
target | Σ I | 1..1 | Reference(DocumentReference) |
description | Σ | 0..1 | string |
securityLabel | Σ | 0..* | CodeableConceptBinding |
content | Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
attachment | Σ I | 1..1 | Attachment |
format | Σ | 0..1 | CodingBinding |
context | Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
encounter | I | 0..* | Reference(Encounter | EpisodeOfCare) |
event | 0..* | CodeableConcept | |
period | Σ I | 0..1 | Period |
facilityType | 0..1 | CodeableConcept | |
practiceSetting | 0..1 | CodeableConcept | |
sourcePatientInfo | I | 0..1 | Reference(Patient) |
related | I | 0..* | Reference(Resource) |
Snapshot View
DocumentReference | I | DocumentReference | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
masterIdentifier | Σ | 0..1 | Identifier |
identifier | Σ | 0..* | Identifier |
status | Σ ?! | 1..1 | codeBinding |
docStatus | Σ | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
category | Σ | 0..* | CodeableConcept |
subject | Σ I | 0..1 | Reference(Patient | Practitioner | Group | Device) |
date | Σ | 0..1 | instant |
author | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) |
authenticator | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
custodian | I | 0..1 | Reference(Organization) |
relatesTo | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | codeBinding |
target | Σ I | 1..1 | Reference(DocumentReference) |
description | Σ | 0..1 | string |
securityLabel | Σ | 0..* | CodeableConceptBinding |
content | Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
attachment | Σ I | 1..1 | Attachment |
format | Σ | 0..1 | CodingBinding |
context | Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
encounter | I | 0..* | Reference(Encounter | EpisodeOfCare) |
event | 0..* | CodeableConcept | |
period | Σ I | 0..1 | Period |
facilityType | 0..1 | CodeableConcept | |
practiceSetting | 0..1 | CodeableConcept | |
sourcePatientInfo | I | 0..1 | Reference(Patient) |
related | I | 0..* | Reference(Resource) |
Examples
Detailed descriptions
Flag | |
Definition | Prospective warnings of potential issues when providing care to the patient. |
Cardinality | 0...* |
Alias | Barriers to Care, Alert, Warning |
Invariants |
|
Mappings |
|
Flag.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Flag.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Flag.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Flag.meta.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Flag.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. |
Invariants |
|
Mappings |
|
Flag.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. |
Invariants |
|
Mappings |
|
Flag.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Mappings |
|
Flag.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants |
|
Mappings |
|
Flag.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
Flag.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Must Support | True |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Mappings |
|
Flag.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Flag.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
Flag.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Flag.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Flag.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Flag.extension:flagDetail | |
Definition | Points to the Observation, AllergyIntolerance or other record that provides additional supporting information about this flag. |
Cardinality | 0...1 |
Type | Extension(Reference(Resource)) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Flag.extension:note | |
Definition | Text extension to contain information where coded values aren't provided or appropriate |
Cardinality | 0...1 |
Type | Extension(Annotation) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Flag.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Flag.identifier | |
Definition | Business identifiers assigned to this flag by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows identification of the flag as it is known by various participating systems and in a way that remains consistent across servers. |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
Flag.status | |
Definition | Supports basic workflow. |
Cardinality | 1...1 |
Type | code |
Binding | Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or was entered in error. |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Flag.category | |
Definition | Allows a flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A general category for flags for filtering/display purposes. |
Summary | True |
Comments | The value set will often need to be adjusted based on local business rules and usage context. |
Invariants |
|
Mappings |
|
Flag.code | |
Definition | The coded value or textual component of the flag to display to the user. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Detail codes identifying specific flagged issues. |
Summary | True |
Comments | If non-coded, use CodeableConcept.text. This element should always be included in the narrative. |
Invariants |
|
Mappings |
|
Flag.subject | |
Definition | The patient, location, group, organization, or practitioner etc. this is about record this flag is associated with. |
Cardinality | 1...1 |
Type | Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Flag.period | |
Definition | The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Flag.encounter | |
Definition | This alert is only relevant during the encounter. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Comments | If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end. |
Invariants |
|
Mappings |
|
Flag.author | |
Definition | The person, organization or device that created the flag. |
Cardinality | 0...1 |
Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|