Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-DocumentReference resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. DocumentReference | |
| Definition | A reference to a document. |
| Short | A reference to a document |
| Comments | Usually, this is used for documents other than those defined by FHIR. |
| Control | 0..* |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. DocumentReference.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. |
| Short | A set of rules under which this content was created |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. DocumentReference.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. Usually modifier elements provide negation or qualification. In order 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. |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 6. DocumentReference.status | |
| Definition | The status of this document reference. |
| Short | current | superseded | entered-in-error |
| Comments | This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/document-reference-status|3.0.2)The status of the document reference. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 8. DocumentReference.type | |
| Definition | Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. |
| Short | Kind of document (LOINC if possible) |
| Comments | Key metadata element describing the document, used in searching/filtering. |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from Document Type Value Sethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes|20091109 (preferred to http://hl7.org/fhir/ValueSet/c80-doc-typecodes|20091109)Precise type of clinical document. |
| Type | CodeableConcept |
| Summary | true |
| 10. DocumentReference.indexed | |
| Definition | When the document reference was created. |
| Short | When this document reference was created |
| Comments | Referencing/indexing time is used for tracking, organizing versions and searching. |
| Control | 1..1 |
| Type | instant |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 12. DocumentReference.relatesTo | |
| Definition | Relationships that this document has with other document references that already exist. |
| Short | Relationships to other documents |
| Comments | This element is labeled as a modifier because documents that append to other documents are incomplete on their own. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
| 14. DocumentReference.relatesTo.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Summary | true |
| Alternate Names | extensions, user content, modifiers |
| 16. DocumentReference.relatesTo.code | |
| Definition | The type of relationship that this document has with anther document. |
| Short | replaces | transforms | signs | appends |
| Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2 (required to http://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2)The type of relationship between documents. |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 18. DocumentReference.relatesTo.target | |
| Definition | The target document of this relationship. |
| Short | Target of the relationship |
| Control | 1..1 |
| Type | Reference(DocumentReference) |
| Summary | true |
| 20. DocumentReference.content | |
| Definition | The document and format referenced. There may be multiple content element repetitions, each with a different format. |
| Short | Document referenced |
| Control | 1..* |
| Type | BackboneElement |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
| 22. DocumentReference.content.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Summary | true |
| Alternate Names | extensions, user content, modifiers |
| 24. DocumentReference.content.attachment | |
| Definition | The document or URL of the document along with critical metadata to prove content has integrity. |
| Short | Where to access the document |
| Control | 1..1 |
| Type | Attachment |
| Summary | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DocumentReference | |
| 2. DocumentReference.author | |
| 4. DocumentReference.author.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DocumentReference.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. DocumentReference.author.extension:author | |
| Slice Name | author |
| Definition | R4: |
| Short | R4: author |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 8. DocumentReference.authenticator | |
| 10. DocumentReference.authenticator.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DocumentReference.authenticator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. DocumentReference.authenticator.extension:authenticator | |
| Slice Name | authenticator |
| Definition | R4: |
| Short | R4: authenticator |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 14. DocumentReference.context | |
| 16. DocumentReference.context.encounter | |
| 18. DocumentReference.context.encounter.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DocumentReference.context.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. DocumentReference.context.encounter.extension:encounter | |
| Slice Name | encounter |
| Definition | R4: |
| Short | R4: encounter additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DocumentReference | |||||
| Definition | A reference to a document. | ||||
| Short | A reference to a document | ||||
| Comments | Usually, this is used for documents other than those defined by FHIR. | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. DocumentReference.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. DocumentReference.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. DocumentReference.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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. DocumentReference.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. DocumentReference.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| 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 in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. DocumentReference.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. | ||||
| Short | Contained, inline 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. DocumentReference.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 16. DocumentReference.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. Usually modifier elements provide negation or qualification. In order 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 18. DocumentReference.masterIdentifier | |||||
| Definition | Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. | ||||
| Short | Master Version Specific Identifier | ||||
| Comments | CDA Document Id extension and root. | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.). | ||||
| 20. DocumentReference.identifier | |||||
| Definition | Other identifiers associated with the document, including version independent identifiers. | ||||
| Short | Other identifiers for the document | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 22. DocumentReference.status | |||||
| Definition | The status of this document reference. | ||||
| Short | current | superseded | entered-in-error | ||||
| Comments | This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from DocumentReferenceStatus (required to http://hl7.org/fhir/ValueSet/document-reference-status|3.0.2)The status of the document reference. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 24. DocumentReference.docStatus | |||||
| Definition | The status of the underlying document. | ||||
| Short | preliminary | final | appended | amended | entered-in-error | ||||
| Comments | The document that is pointed to might be in various lifecycle states. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from CompositionStatus (required to http://hl7.org/fhir/ValueSet/composition-status|3.0.2)Status of the underlying document. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 26. DocumentReference.type | |||||
| Definition | Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. | ||||
| Short | Kind of document (LOINC if possible) | ||||
| Comments | Key metadata element describing the document, used in searching/filtering. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHOULD be taken from Document Type Value Set (preferred to http://hl7.org/fhir/ValueSet/c80-doc-typecodes|20091109)Precise type of clinical document. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 28. DocumentReference.class | |||||
| Definition | A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. | ||||
| Short | Categorization of document | ||||
| Comments | This is a metadata field from XDS/MHD. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Document Class Value Set (example to http://hl7.org/fhir/ValueSet/c80-doc-classcodes|20091109)High-level kind of a clinical document at a macro level. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Helps humans to assess whether the document is of interest when viewing a list of documents. | ||||
| Alternate Names | kind | ||||
| 30. DocumentReference.subject | |||||
| Definition | Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). | ||||
| Short | Who/what is the subject of the document | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient, Practitioner, Group, Device) | ||||
| Summary | true | ||||
| 32. DocumentReference.created | |||||
| Definition | When the document was created. | ||||
| Short | Document creation time | ||||
| Comments | Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based. | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 34. DocumentReference.indexed | |||||
| Definition | When the document reference was created. | ||||
| Short | When this document reference was created | ||||
| Comments | Referencing/indexing time is used for tracking, organizing versions and searching. | ||||
| Control | 1..1 | ||||
| Type | instant | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 36. DocumentReference.author | |||||
| Definition | Identifies who is responsible for adding the information to the document. | ||||
| Short | Who and/or what authored the document | ||||
| Comments | Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant). | ||||
| Control | 0..* | ||||
| Type | Reference(Practitioner, Organization, Device, Patient, RelatedPerson) | ||||
| Summary | true | ||||
| 38. DocumentReference.author.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 40. DocumentReference.author.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DocumentReference.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 42. DocumentReference.author.extension:author | |||||
| Slice Name | author | ||||
| Definition | R4: | ||||
| Short | R4: author | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 44. DocumentReference.author.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 46. DocumentReference.author.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 48. DocumentReference.author.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 50. DocumentReference.authenticator | |||||
| Definition | Which person or organization authenticates that this document is valid. | ||||
| Short | Who/what authenticated the document | ||||
| Comments | Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator. | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner, Organization) | ||||
| Summary | true | ||||
| 52. DocumentReference.authenticator.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 54. DocumentReference.authenticator.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DocumentReference.authenticator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 56. DocumentReference.authenticator.extension:authenticator | |||||
| Slice Name | authenticator | ||||
| Definition | R4: | ||||
| Short | R4: authenticator | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 58. DocumentReference.authenticator.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 60. DocumentReference.authenticator.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 62. DocumentReference.authenticator.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 64. DocumentReference.custodian | |||||
| Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. | ||||
| Short | Organization which maintains the document | ||||
| Comments | Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location of the document, which is the technical location of the document, which host may be delegated to the management of some other organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| 66. DocumentReference.relatesTo | |||||
| Definition | Relationships that this document has with other document references that already exist. | ||||
| Short | Relationships to other documents | ||||
| Comments | This element is labeled as a modifier because documents that append to other documents are incomplete on their own. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 68. DocumentReference.relatesTo.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 70. DocumentReference.relatesTo.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 72. DocumentReference.relatesTo.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 74. DocumentReference.relatesTo.code | |||||
| Definition | The type of relationship that this document has with anther document. | ||||
| Short | replaces | transforms | signs | appends | ||||
| Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from DocumentRelationshipType (required to http://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2)The type of relationship between documents. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 76. DocumentReference.relatesTo.target | |||||
| Definition | The target document of this relationship. | ||||
| Short | Target of the relationship | ||||
| Control | 1..1 | ||||
| Type | Reference(DocumentReference) | ||||
| Summary | true | ||||
| 78. DocumentReference.description | |||||
| Definition | Human-readable description of the source document. This is sometimes known as the "title". | ||||
| Short | Human-readable description (title) | ||||
| Comments | What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note"). | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Helps humans to assess whether the document is of interest. | ||||
| 80. DocumentReference.securityLabel | |||||
| Definition | A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. | ||||
| Short | Document security-tags | ||||
| Comments | The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels ![]() (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. | ||||
| 82. DocumentReference.content | |||||
| Definition | The document and format referenced. There may be multiple content element repetitions, each with a different format. | ||||
| Short | Document referenced | ||||
| Control | 1..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 84. DocumentReference.content.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 86. DocumentReference.content.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 88. DocumentReference.content.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 90. DocumentReference.content.attachment | |||||
| Definition | The document or URL of the document along with critical metadata to prove content has integrity. | ||||
| Short | Where to access the document | ||||
| Control | 1..1 | ||||
| Type | Attachment | ||||
| Summary | true | ||||
| 92. DocumentReference.content.format | |||||
| Definition | An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. | ||||
| Short | Format/content rules for the document | ||||
| Comments | Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from DocumentReference Format Code Set ![]() (preferred to http://hl7.org/fhir/ValueSet/formatcodes|20150326)Document Format Codes. | ||||
| Type | Coding | ||||
| Summary | true | ||||
| 94. DocumentReference.context | |||||
| Definition | The clinical context in which the document was prepared. | ||||
| Short | Clinical context of document | ||||
| Comments | These values are primarily added to help with searching for interesting/relevant documents. | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 96. DocumentReference.context.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 98. DocumentReference.context.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 100. DocumentReference.context.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 102. DocumentReference.context.encounter | |||||
| Definition | Describes the clinical encounter or type of care that the document content is associated with. | ||||
| Short | Context of the document content | ||||
| Control | 0..1 | ||||
| Type | Reference(Encounter) | ||||
| Summary | true | ||||
| 104. DocumentReference.context.encounter.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 106. DocumentReference.context.encounter.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DocumentReference.context.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 108. DocumentReference.context.encounter.extension:encounter | |||||
| Slice Name | encounter | ||||
| Definition | R4: | ||||
| Short | R4: encounter additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 110. DocumentReference.context.encounter.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 112. DocumentReference.context.encounter.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 114. DocumentReference.context.encounter.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 116. DocumentReference.context.event | |||||
| Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. | ||||
| Short | Main clinical acts documented | ||||
| Comments | An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ActCode|2016-11-11 (example to http://hl7.org/fhir/ValueSet/v3-ActCode|2016-11-11)This list of codes represents the main clinical acts being documented. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 118. DocumentReference.context.period | |||||
| Definition | The time period over which the service that is described by the document was provided. | ||||
| Short | Time of service that is being documented | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 120. DocumentReference.context.facilityType | |||||
| Definition | The kind of facility where the patient was seen. | ||||
| Short | Kind of facility where patient was seen | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Facility Type Code Value Set (example to http://hl7.org/fhir/ValueSet/c80-facilitycodes|20091109)XDS Facility Type. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 122. DocumentReference.context.practiceSetting | |||||
| Definition | This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. | ||||
| Short | Additional details about where the content was created (e.g. clinical specialty) | ||||
| Comments | The value set for this content has an example binding because it is a value set decided by community policy. Other examples exist for consideration: * HITSP created the table HITSP/C80 Table 2-148 Clinical Specialty Value Set (a value set based upon SNOMED CT which is referenced by Direct (XDR and XDM for Direct Messaging Specification, Version 1), as well as Nationwide Health Information Network (NHIN). Query for Documents, Web Service Interface Specification, V 3.0, 07/27/2011 * ELGA (Austria) (ELGA CDA Implementie-rungsleitfäden Registrierung von CDA Dokumenten für ELGA mit IHE Cross-Enterprise Document Sharing: XDS Metadaten (XDSDocumentEntry), [1.2.40.0.34.7.6.3] * XDS Connect-a-thon practiceSettingCode. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Practice Setting Code Value Set (example to http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109)Additional details about where the content was created (e.g. clinical specialty). | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. | ||||
| 124. DocumentReference.context.sourcePatientInfo | |||||
| Definition | The Patient Information as known when the document was published. May be a reference to a version specific, or contained. | ||||
| Short | Patient demographics from source | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient) | ||||
| Summary | true | ||||
| 126. DocumentReference.context.related | |||||
| Definition | Related identifiers or resources associated with the DocumentReference. | ||||
| Short | Related identifiers or resources | ||||
| Comments | May be identifiers or resources that caused the DocumentReference or referenced Document to be created. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 128. DocumentReference.context.related.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 130. DocumentReference.context.related.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 132. DocumentReference.context.related.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 134. DocumentReference.context.related.identifier | |||||
| Definition | Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing. | ||||
| Short | Identifier of related objects or events | ||||
| Comments | Order numbers, accession numbers, XDW workflow numbers. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 136. DocumentReference.context.related.ref | |||||
| Definition | Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing. | ||||
| Short | Related Resource | ||||
| Comments | Order, ProcedureRequest, Procedure, EligibilityRequest, etc. | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Summary | true | ||||