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

ErrorStructureDefinition.urlValues for url differ: 'http://fhir.org/guides/argonaut/StructureDefinition/argo-documentreference' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference'
InformationStructureDefinition.nameValues for name differ: 'Argonaut DocumentReference Profile' vs 'USCoreDocumentReferenceProfile'
InformationStructureDefinition.statusValues for status differ: 'draft' vs 'active'
InformationStructureDefinition.dateValues for date differ: '2016-10-18T00:00:00+11:00' vs '2023-10-17'
InformationStructureDefinition.publisherValues for publisher differ: 'Argonaut Project' vs 'HL7 International / Cross-Group Projects'
InformationStructureDefinition.jurisdictionAdded the item 'urn:iso:std:iso:3166#US'
WarningStructureDefinition.fhirVersionValues for fhirVersion differ: '1.0.2' vs '4.0.1'
InformationStructureDefinition.shortValues for short differ: 'Argonaut DocumentReference Profile' vs 'A reference to a document'
InformationStructureDefinition.definitionValues for definition differ: 'A reference to a document .' vs '\-'
InformationStructureDefinition.commentValues for comment differ: 'Usually, this is used for documents other than those defined by FHIR.' vs '\-'
InformationDocumentReferenceStructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.contained.empty())
InformationDocumentReferenceStructureDefinition 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())
InformationDocumentReferenceStructureDefinition 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())
InformationDocumentReferenceStructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (contained.meta.security.empty())
InformationDocumentReferenceStructureDefinition USCoreDocumentReferenceProfile has added constraint that is not found in Argonaut DocumentReference Profile and it is uncertain whether they are compatible (text.`div`.exists())
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.commentValues 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).'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.definitionValues 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).'
InformationStructureDefinition.requirementsValues 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.).'
InformationDocumentReference.identifierElement maximum cardinalities differ: '1' vs '2147483647'
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.commentValues 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).'
WarningDocumentReference.authorElements differ in definition for mustSupport: 'false' vs 'true'
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.shortValues for short differ: 'preliminary | final | appended | amended | entered-in-error' vs 'preliminary | final | amended | entered-in-error'
InformationStructureDefinition.shortValues for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized'
InformationStructureDefinition.definitionValues 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).'
InformationStructureDefinition.shortValues for short differ: 'Human-readable description (title)' vs 'Human-readable description'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.commentValues 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.'
InformationStructureDefinition.commentValues 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.'
InformationDocumentReference.contentElement maximum cardinalities differ: '1' vs '2147483647'
InformationStructureDefinition.shortValues for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized'
InformationStructureDefinition.definitionValues 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).'
InformationStructureDefinition.definitionValues 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.'
InformationDocumentReference.content.attachmentStructureDefinition 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())
InformationStructureDefinition.shortValues for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
InformationStructureDefinition.definitionValues 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.'
InformationDocumentReference.content.attachment.contentTypeElement minimum cardinalities differ: '1' vs '0'
InformationStructureDefinition.definitionValues 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.'
WarningDocumentReference.content.attachment.dataElements differ in definition for mustSupport: 'false' vs 'true'
InformationStructureDefinition.shortValues for short differ: 'https address' vs 'Uri where the data can be found'
InformationStructureDefinition.definitionValues 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.'
InformationDocumentReference.content.attachment.urlElement minimum cardinalities differ: '1' vs '0'
InformationStructureDefinition.definitionValues 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).'
InformationStructureDefinition.requirementsValues 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).'
InformationDocumentReference.content.formatElement minimum cardinalities differ: '1' vs '0'
InformationStructureDefinition.shortValues for short differ: 'xml:id (or equivalent in JSON)' vs 'Unique id for inter-element referencing'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Additional Content defined by implementations' vs 'Additional content defined by implementations'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.shortValues for short differ: 'Extensions that cannot be ignored' vs 'Extensions that cannot be ignored even if unrecognized'
InformationStructureDefinition.definitionValues 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).'
WarningDocumentReference.context.encounterElements differ in definition for mustSupport: 'false' vs 'true'
InformationStructureDefinition.shortValues for short differ: 'Main Clinical Acts Documented' vs 'Main clinical acts documented'
InformationStructureDefinition.definitionValues 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.'
InformationStructureDefinition.commentValues 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

NameValueComments
.abstractfalse
    .baseDefinitionhttp://hl7.org/fhir/StructureDefinition/DocumentReference
      .copyrightUsed 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'
      .date2016-10-18T00:00:00+11:002023-10-17
      • Values Differ
      .descriptionTo promote interoperability and adoption through common implementation, this profile sets minimum expectations for searching and fetching patient documents including Clinical Notes using the DocumentReference resource. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases. Prior to reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of US Core DocumentReference Profile and US Core DiagnosticReport Profile for Report and Note exchange.
      • Added the item 'To promote interoperability and adoption through common implementation, this profile sets minimum expectations for searching and fetching patient documents including Clinical Notes using the DocumentReference resource. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains the way the elements are used when using the profile. It provides the floor for standards development for specific use cases. Prior to reviewing this profile, implementers are encouraged to read the Clinical Notes Guidance to understand the overlap of US Core DocumentReference Profile and US Core DiagnosticReport Profile for Report and Note exchange.'
      .experimentalfalse
      • Added the item 'false'
      .fhirVersion1.0.24.0.1
      • Values Differ
      .jurisdiction
        ..jurisdiction[0]urn:iso:std:iso:3166#US
        • Added the item 'urn:iso:std:iso:3166#US'
        .kindresource
          .nameArgonaut DocumentReference ProfileUSCoreDocumentReferenceProfile
          • Values Differ
          .publisherArgonaut ProjectHL7 International / Cross-Group Projects
          • Values Differ
          .purpose
            .statusdraftactive
            • Values Differ
            .titleUS Core DocumentReference Profile
            • Added the item 'US Core DocumentReference Profile'
            .typeDocumentReference
              .urlhttp://fhir.org/guides/argonaut/StructureDefinition/argo-documentreferencehttp://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference
              • Values Differ
              .version7.0.0-ballot
              • Added the item '7.0.0-ballot'

              Structure

              NameL FlagsL Card.L TypeL Description & ConstraintsR FlagsR Card.R TypeR Description & ConstraintsCommentsdoco
              .. DocumentReference 0..*DocumentReferenceArgonaut DocumentReference Profile
              0..*DocumentReferenceA 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..1idLogical id of this artifactΣ0..1idLogical id of this artifact
                ... meta Σ0..1MetaMetadata about the resourceΣ0..1MetaMetadata about the resource
                  ... implicitRules ?!Σ0..1uriA set of rules under which this content was created?!Σ0..1uriA set of rules under which this content was created
                    ... language 0..1codeLanguage of the resource content
                    Binding: ?? (required): A human language.

                    0..1codeLanguage of the resource content
                    Binding: ?? (preferred): A human language.

                    Additional BindingsPurpose
                    ??Max Binding
                      ... text 0..1NarrativeText summary of the resource, for human interpretation0..1NarrativeText summary of the resource, for human interpretation
                        ... contained 0..*ResourceContained, inline Resources
                        0..*ResourceContained, inline Resources
                          ... extension 0..*ExtensionAdditional Content defined by implementations
                          0..*ExtensionAdditional content defined by implementations
                            ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
                            ?!0..*ExtensionExtensions that cannot be ignored
                              ... masterIdentifier Σ0..1IdentifierMaster Version Specific IdentifierΣ0..1IdentifierMaster Version Specific Identifier
                                ... identifier S0..1IdentifierOther identifiers for the document
                                SΣ0..*IdentifierOther identifiers for the document
                                • Element maximum cardinalities differ: '1' vs '2147483647'
                                ... subject S1..1Reference(Argonaut Patient Profile)Who/what is the subject of the documentSΣ1..1Reference(US Core Patient Profile S | Practitioner | Group | Device)Who/what is the subject of the document
                                  ... type S1..1CodeableConceptKind of document (LOINC if possible)
                                  Binding: ?? (required)
                                  SΣ1..1CodeableConceptKind 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 BindingsPurpose
                                  ??Min Binding
                                    ... class Σ0..1CodeableConceptCategorization 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 | Device)Who and/or what authored the document
                                    • Elements differ in definition for mustSupport: 'false' vs 'true'
                                    ... custodian Σ0..1Reference(Organization)Organization which maintains the document0..1Reference(Organization)Organization which maintains the document
                                      ... authenticator Σ0..1Reference(Practitioner | Organization)Who/what authenticated the document0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document
                                        ... created S0..1dateTimeDocument creation time
                                        • Removed this element
                                        ... indexed S1..1instantWhen this document reference created
                                        • Removed this element
                                        ... status ?!S1..1codecurrent | superseded | entered-in-error
                                        Binding: ?? (required)
                                        ?!SΣ1..1codecurrent | superseded | entered-in-error
                                        Binding: ?? (required)
                                          ... docStatus Σ0..1CodeableConceptpreliminary | final | appended | amended | entered-in-error
                                          Binding: ?? (required): Status of the underlying document.

                                          Σ0..1codepreliminary | final | amended | entered-in-error
                                          Binding: ?? (required): Status of the underlying document.

                                            ... relatesTo ?!Σ0..*BackboneElementRelationships to other documents
                                            Σ0..*BackboneElementRelationships to other documents
                                              .... id 0..1idxml:id (or equivalent in JSON)0..1stringUnique id for inter-element referencing
                                                .... extension 0..*ExtensionAdditional Content defined by implementations
                                                0..*ExtensionAdditional content defined by implementations
                                                  .... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
                                                  ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                    .... code Σ1..1codereplaces | transforms | signs | appends
                                                    Binding: ?? (required): The type of relationship between documents.

                                                    Σ1..1codereplaces | transforms | signs | appends
                                                    Binding: ?? (required): The type of relationship between documents.

                                                      .... target Σ1..1Reference(DocumentReference)Target of the relationshipΣ1..1Reference(DocumentReference)Target of the relationship
                                                        ... description Σ0..1stringHuman-readable description (title)Σ0..1stringHuman-readable description
                                                          ... securityLabel Σ0..*CodeableConceptDocument security-tags
                                                          Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


                                                          Σ0..*CodeableConceptDocument security-tags
                                                          Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


                                                            ... content S1..1BackboneElementDocument referenced
                                                            SΣ1..*BackboneElementDocument referenced
                                                            • Element maximum cardinalities differ: '1' vs '2147483647'
                                                            .... id 0..1idxml:id (or equivalent in JSON)0..1stringUnique id for inter-element referencing
                                                              .... extension 0..*ExtensionAdditional Content defined by implementations
                                                              0..*ExtensionAdditional content defined by implementations
                                                                .... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
                                                                ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                  .... attachment S1..1AttachmentWhere to access the documentSΣC1..1AttachmentWhere to access the document
                                                                  us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present.
                                                                  • 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..1idxml:id (or equivalent in JSON)0..1stringUnique id for inter-element referencing
                                                                    ..... extension 0..*ExtensionAdditional Content defined by implementations
                                                                    0..*ExtensionAdditional content defined by implementations
                                                                    Slice: Unordered, Open by value:url
                                                                      ..... contentType S1..1codeMime 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..1codeMime 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..1codeHuman language of the content (BCP-47)
                                                                      Binding: ?? (required): A human language.


                                                                      Example General: en-AU
                                                                      Σ0..1codeHuman language of the content (BCP-47)
                                                                      Binding: ?? (preferred): A human language.

                                                                      Additional BindingsPurpose
                                                                      ??Max Binding

                                                                      Example General: en-AU
                                                                        ..... data Σ0..1base64BinaryData inline, base64edSC0..1base64BinaryData inline, base64ed
                                                                        • Elements differ in definition for mustSupport: 'false' vs 'true'
                                                                        ..... url S1..1urihttps address
                                                                        Example General: http://www.acme.com/logo-small.png
                                                                        SΣC0..1urlUri where the data can be found
                                                                        Example General: http://www.acme.com/logo-small.png
                                                                        • Element minimum cardinalities differ: '1' vs '0'
                                                                        ..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)Σ0..1unsignedIntNumber of bytes of content (if url provided)
                                                                          ..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)Σ0..1base64BinaryHash of the data (sha-1, base64ed)
                                                                            ..... title Σ0..1stringLabel to display in place of the data
                                                                            Example General: Official Corporate Logo
                                                                            Σ0..1stringLabel to display in place of the data
                                                                            Example General: Official Corporate Logo
                                                                              ..... creation Σ0..1dateTimeDate attachment was first createdΣ0..1dateTimeDate attachment was first created
                                                                                .... format S1..1CodingFormat/content rules for the document
                                                                                Binding: ?? (extensible)
                                                                                SΣ0..1CodingFormat/content rules for the document
                                                                                Binding: ?? (extensible)
                                                                                • Element minimum cardinalities differ: '1' vs '0'
                                                                                ... context S0..1BackboneElementClinical context of documentSΣ0..1BackboneElementClinical context of document
                                                                                  .... id 0..1idxml:id (or equivalent in JSON)0..1stringUnique id for inter-element referencing
                                                                                    .... extension 0..*ExtensionAdditional Content defined by implementations
                                                                                    0..*ExtensionAdditional content defined by implementations
                                                                                      .... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
                                                                                      ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                        .... encounter Σ0..1Reference(Encounter)Context of the document contentS0..1Reference(US Core Encounter Profile)Context of the document content
                                                                                        • Elements differ in definition for mustSupport: 'false' vs 'true'
                                                                                        .... event Σ0..*CodeableConceptMain Clinical Acts Documented
                                                                                        Binding: ?? (example): This list of codes represents the main clinical acts being documented.


                                                                                        0..*CodeableConceptMain clinical acts documented
                                                                                        Binding: ?? (example): This list of codes represents the main clinical acts being documented.


                                                                                          .... period S0..1PeriodTime of service that is being documentedSΣ0..1PeriodTime of service that is being documented
                                                                                            .... facilityType Σ0..1CodeableConceptKind of facility where patient was seen
                                                                                            Binding: ?? (example): XDS Facility Type.

                                                                                            0..1CodeableConceptKind of facility where patient was seen
                                                                                            Binding: ?? (example): XDS Facility Type.

                                                                                              .... practiceSetting Σ0..1CodeableConceptAdditional 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..1CodeableConceptAdditional 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..1Reference(Patient)Patient demographics from source0..1Reference(Patient)Patient demographics from source
                                                                                                  .... related Σ0..*BackboneElementRelated identifiers or resources
                                                                                                  0..*Reference(Resource)Related identifiers or resources
                                                                                                    ..... id 0..1idxml:id (or equivalent in JSON)
                                                                                                    • Removed this element
                                                                                                    ..... extension 0..*ExtensionAdditional Content defined by implementations
                                                                                                    • Removed this element
                                                                                                    ..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
                                                                                                    • Removed this element
                                                                                                    ..... identifier Σ0..1IdentifierIdentifier of related objects or events
                                                                                                    • Removed this element
                                                                                                    ..... ref Σ0..1Reference(Resource)Related Resource
                                                                                                    • Removed this element
                                                                                                    ... Slices for category SΣ1..*CodeableConceptCategorization of document
                                                                                                    Slice: Unordered, Open by pattern:$this
                                                                                                    Binding: ?? (example): High-level kind of a clinical document at a macro level.


                                                                                                    • Added this element
                                                                                                    ... date SΣ0..1instantWhen this document reference was created
                                                                                                    • Added this element

                                                                                                    doco Documentation for this format