## Profile Comparison between http://fhir.org/guides/argonaut/StructureDefinition/argo-documentreference vs http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference

Left: | Argonaut DocumentReference Profile (http://fhir.org/guides/argonaut/StructureDefinition/argo-documentreference)
Right: | US Core DocumentReference Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference)

### Messages

Error | StructureDefinition.url | Values for url differ: 'http://fhir.org/guides/argonaut/StructureDefinition/argo-documentreference' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference'
Information | StructureDefinition.name | Values for name differ: 'Argonaut DocumentReference Profile' vs 'USCoreDocumentReferenceProfile'
Information | StructureDefinition.status | Values for status differ: 'draft' vs 'active'
Information | StructureDefinition.date | Values for date differ: '2016-10-18T00:00:00+11:00' vs '2023-10-17'
Information | StructureDefinition.publisher | Values for publisher differ: 'Argonaut Project' vs 'HL7 International / Cross-Group Projects'
Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#US'
Warning | StructureDefinition.fhirVersion | Values for fhirVersion differ: '1.0.2' vs '4.0.1'
Information | StructureDefinition.short | Values for short differ: 'Argonaut DocumentReference Profile' vs 'A reference to a document'
Information | StructureDefinition.definition | Values for definition differ: 'A reference to a document .' vs 'A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text.'
Information | DocumentReference | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.contained.empty())
Information | DocumentReference | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
Information | DocumentReference | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
Information | DocumentReference | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.meta.security.empty())
Information | DocumentReference | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (text.`div`.exists())
Information | StructureDefinition.comment | Values for comment differ: 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.' vs 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation.'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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.'
Information | StructureDefinition.definition | Values for definition differ: 'A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.' vs '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.'
Information | StructureDefinition.comment | Values for comment differ: '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 as much as possible.' vs '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.'
Information | StructureDefinition.comment | Values for comment differ: '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).' vs '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).'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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.'
Information | StructureDefinition.comment | Values for comment differ: 'Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.' vs '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.'
Information | StructureDefinition.comment | Values for comment differ: '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.' vs '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.'
Information | StructureDefinition.short | Values for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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.'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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).'
Information | StructureDefinition.requirements | Values for requirements differ: '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.).' vs '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.).'
Information | DocumentReference.identifier | Element maximum cardinalities differ: '1' vs '2147483647'
Error | DocumentReference.subject | Type Mismatch: Reference([CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-patient]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient], CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner], CanonicalType[http://hl7.org/fhir/StructureDefinition/Group], CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-device]])
Information | StructureDefinition.comment | Values for comment differ: 'Key metadata element describing the document, used in searching/filtering.' vs 'Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.'
Information | StructureDefinition.comment | Values for comment differ: 'Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant).' vs 'Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).'
Warning | DocumentReference.author | Elements differ in definition for mustSupport: 'false' vs 'true'
Information | StructureDefinition.comment | Values for comment differ: '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.' vs 'Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.'
Information | StructureDefinition.comment | Values for comment differ: 'This is the status of the DocumentReference object, which might be independent from the docStatus element.' vs '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.'
Information | StructureDefinition.short | Values for short differ: 'preliminary | final | appended | amended | entered-in-error' vs 'preliminary | final | amended | entered-in-error'
Information | StructureDefinition.short | Values for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
Information | StructureDefinition.definition | Values for definition differ: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.'
Information | StructureDefinition.short | Values for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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.'
Information | StructureDefinition.short | Values for short differ: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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 in which it is contained 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 can 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).'
Information | StructureDefinition.short | Values for short differ: 'Human-readable description (title)' vs 'Human-readable description'
Information | StructureDefinition.definition | Values for definition differ: 'Human-readable description of the source document. This is sometimes known as the 'title'.' vs 'Human-readable description of the source document.'
Information | StructureDefinition.comment | Values for comment differ: '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').' vs 'What the document is about, a terse summary of the document.'
Information | StructureDefinition.comment | Values for comment differ: '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.' vs '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.'
Information | DocumentReference.content | Element maximum cardinalities differ: '1' vs '2147483647'
Information | StructureDefinition.short | Values for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
Information | StructureDefinition.definition | Values for definition differ: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.'
Information | StructureDefinition.short | Values for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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.'
Information | StructureDefinition.short | Values for short differ: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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 in which it is contained 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 can 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).'
Information | StructureDefinition.definition | Values for definition differ: 'The document or url of the document along with critical metadata to prove content has integrity.' vs 'The document and format referenced.'
Information | DocumentReference.content.attachment | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (url.exists() or data.exists())
Information | StructureDefinition.short | Values for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
Information | StructureDefinition.definition | Values for definition differ: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.'
Information | StructureDefinition.short | Values for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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.'
Information | DocumentReference.content.attachment.contentType | Element minimum cardinalities differ: '1' vs '0'
Information | StructureDefinition.definition | Values for definition differ: 'The actual data of the attachment - a sequence of bytes. In XML, represented using base64.' vs 'The actual data of the attachment - a sequence of bytes, base64 encoded.'
Warning | DocumentReference.content.attachment.data | Elements differ in definition for mustSupport: 'false' vs 'true'
Information | StructureDefinition.short | Values for short differ: 'https address' vs 'Uri where the data can be found'
Information | StructureDefinition.definition | Values for definition differ: 'The https address where the document can be retrieved. For example, this address may refer to a FHIR Binary Resource (i.e. [base]/Binary/[id]) address on the server.' vs 'A location where the data can be accessed.'
Information | DocumentReference.content.attachment.url | Element minimum cardinalities differ: '1' vs '0'
Information | StructureDefinition.definition | Values for definition differ: 'The number of bytes of data that make up this attachment.' vs 'The number of bytes of data that make up this attachment (before base64 encoding, if that is done).'
Information | StructureDefinition.requirements | Values for requirements differ: 'Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.' vs 'Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).'
Information | DocumentReference.content.format | Element minimum cardinalities differ: '1' vs '0'
Information | StructureDefinition.short | Values for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
Information | StructureDefinition.definition | Values for definition differ: 'unique id for the element within a resource (for internal references).' vs 'Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.'
Information | StructureDefinition.short | Values for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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.'
Information | StructureDefinition.short | Values for short differ: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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 in which it is contained 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 can 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).'
Warning | DocumentReference.context.encounter | Elements differ in definition for mustSupport: 'false' vs 'true'
Information | StructureDefinition.short | Values for short differ: 'Main Clinical Acts Documented' vs 'Main clinical acts documented'
Information | StructureDefinition.definition | Values for definition differ: '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.' vs '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 type Code, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.'
Information | StructureDefinition.comment | Values for comment differ: '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.' vs 'This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.'

### Metadata

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 | Added the item 'Used by permission of HL7 International, all rights reserved Creative Commons License'
date | 2016-10-18T00:00:00+11:00 | 2023-10-17 | Values Differ
description |  | The US Core DocumentReference Profile inherits from the FHIR [DocumentReference](https://hl7.org/fhir/R4/documentreference.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for searching and fetching patient documents including Clinical Notes using the DocumentReference resource. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. Before reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of the US Core DiagnosticReport Profile for Report and Note exchange and the US Core DocumentReference Profile. | Added the item 'The US Core DocumentReference Profile inherits from the FHIR [DocumentReference](https://hl7.org/fhir/R4/documentreference.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for searching and fetching patient documents including Clinical Notes using the DocumentReference resource. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. Before reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of the US Core DiagnosticReport Profile for Report and Note exchange and the US Core DocumentReference Profile.'
experimental |  | false | Added the item 'false'
fhirVersion | 1.0.2 | 4.0.1 | Values Differ
jurisdiction |  |
jurisdiction[0] |  | urn:iso:std:iso:3166#US | Added the item 'urn:iso:std:iso:3166#US'
kind | resource |
name | Argonaut DocumentReference Profile | USCoreDocumentReferenceProfile | Values Differ
publisher | Argonaut Project | HL7 International / Cross-Group Projects | Values Differ
purpose |  |
status | draft | active | Values Differ
title |  | US Core DocumentReference Profile | Added the item 'US Core DocumentReference Profile'
type | DocumentReference |
url | http://fhir.org/guides/argonaut/StructureDefinition/argo-documentreference | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | Values Differ
version |  | 9.0.0 | Added the item '9.0.0'

### Structure

Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
DocumentReference |  | 0..* | DocumentReference | Argonaut DocumentReference Profile |  | 0..* | DocumentReference | A reference to a document | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.contained.empty()) StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.meta.security.empty()) StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (text.`div`.exists())
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: ?? (required): A human language. |  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
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 | S | 0..1 | Identifier | Other identifiers for the document | S Σ | 0..* | Identifier | Other identifiers for the document | Element maximum cardinalities differ: '1' vs '2147483647'
subject | S | 1..1 | Reference(Argonaut Patient Profile) | Who/what is the subject of the document | S Σ | 1..1 | Reference(US Core Patient Profile S | Practitioner | Group | US Core Device Profile) | Who/what is the subject of the document | Type Mismatch: Reference([CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-patient]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient], CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner], CanonicalType[http://hl7.org/fhir/StructureDefinition/Group], CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-device]])
type | S | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (required) | S Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (required): All LOINC values whose SCALE is "Doc" in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
Additional Bindings | Purpose | Documentation
?? | Min Binding | Must Support, at a minimum, the 10 "Common Clinical Notes" Types
class | Σ | 0..1 | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. |  |  |  |  | Removed this element
author | Σ | 0..* | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | S Σ | 0..* | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | US Core RelatedPerson Profile | US Core Device Profile) | Who and/or what authored the document | Elements differ in definition for mustSupport: 'false' vs 'true'
custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the document |  | 0..1 | Reference(Organization) | Organization which maintains the document |
authenticator | Σ | 0..1 | Reference(Practitioner | Organization) | Who/what authenticated the document |  | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document |
created | S | 0..1 | dateTime | Document creation time |  |  |  |  | Removed this element
indexed | S | 1..1 | instant | When this document reference created |  |  |  |  | Removed this element
status | ?!S | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required) | ?!S Σ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required) |
docStatus | Σ | 0..1 | CodeableConcept | preliminary | final | appended | 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. |
relatesTo | ?!Σ | 0..* | BackboneElement | Relationships to other documents | Σ | 0..* | BackboneElement | Relationships to other documents |
id |  | 0..1 | id | xml:id (or equivalent in JSON) |  | 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 | ?!Σ | 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 (title) | Σ | 0..1 | string | Human-readable description |
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
content | S | 1..1 | BackboneElement | Document referenced | S Σ | 1..* | BackboneElement | Document referenced | Element maximum cardinalities differ: '1' vs '2147483647'
id |  | 0..1 | id | xml:id (or equivalent in JSON) |  | 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 | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | S | 1..1 | Attachment | Where to access the document | S Σ C | 1..1 | Attachment | Where to access the document Constraints: us-core-6 | StructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (url.exists() or data.exists())
id |  | 0..1 | id | xml:id (or equivalent in JSON) |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional Content defined by implementations |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
contentType | S | 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. Example General: text/plain; charset=UTF-8, image/png | S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | Element minimum cardinalities differ: '1' vs '0'
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (required): A human language. Example General: en-AU | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
Example General: en-AU |
data | Σ | 0..1 | base64Binary | Data inline, base64ed | S C | 0..1 | base64Binary | Data inline, base64ed | Elements differ in definition for mustSupport: 'false' vs 'true'
url | S | 1..1 | uri | https address Example General: http://www.acme.com/logo-small.png | S Σ C | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | Element minimum cardinalities differ: '1' vs '0'
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 | S | 1..1 | Coding | Format/content rules for the document Binding: ?? (extensible) | S Σ | 0..1 | Coding | Format/content rules for the document Binding: ?? (extensible) | Element minimum cardinalities differ: '1' vs '0'
context | S | 0..1 | BackboneElement | Clinical context of document | S Σ | 0..1 | BackboneElement | Clinical context of document |
id |  | 0..1 | id | xml:id (or equivalent in JSON) |  | 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 | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
encounter | Σ | 0..1 | Reference(Encounter) | Context of the document content | S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content | Elements differ in definition for mustSupport: 'false' vs 'true'
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 | S | 0..1 | Period | Time of service that is being documented | S Σ | 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..* | BackboneElement | Related identifiers or resources |  | 0..* | Reference(Resource) | Related identifiers or resources |
id |  | 0..1 | id | xml:id (or equivalent in JSON) |  |  |  |  | Removed this element
extension |  | 0..* | Extension | Additional Content defined by implementations |  |  |  |  | Removed this element
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |  |  |  |  | Removed this element
identifier | Σ | 0..1 | Identifier | Identifier of related objects or events |  |  |  |  | Removed this element
ref | Σ | 0..1 | Reference(Resource) | Related Resource |  |  |  |  | Removed this element
Slices for category |  |  |  |  | S Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ?? (example): High-level kind of a clinical document at a macro level. | Added this element
date |  |  |  |  | S Σ | 0..1 | instant | When this document reference was created | Added this element
Documentation for this format