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

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

Messages

ErrorStructureDefinition.versionValues for version differ: '3.1.1' vs '7.0.0'
InformationStructureDefinition.dateValues for date differ: '2020-07-02' vs '2023-10-17'
InformationStructureDefinition.publisherValues for publisher differ: 'HL7 US Realm Steering Committee' vs 'HL7 International / Cross-Group Projects'
InformationStructureDefinition.definitionValues for definition differ: 'This is a basic constraint on DocumentRefernce for use in the US Core IG.' 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.'
WarningDocumentReference.custodianElements differ in definition for mustSupport: 'true' vs 'false'
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.attachment.contentTypeElement minimum cardinalities differ: '1' vs '0'
InformationStructureDefinition.commentValues for comment differ: 'The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.' vs 'The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.'

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'
      .date2020-07-022023-10-17
      • Values Differ
      .descriptionThe document reference profile used in US Core.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.
      • Values Differ
      .experimentalfalse
        .fhirVersion4.0.1
          .jurisdiction
            ..jurisdiction[0]urn:iso:std:iso:3166#US
              .kindresource
                .nameUSCoreDocumentReferenceProfile
                  .publisherHL7 US Realm Steering CommitteeHL7 International / Cross-Group Projects
                  • Values Differ
                  .purpose
                    .statusactive
                      .titleUS Core DocumentReference Profile
                        .typeDocumentReference
                          .urlhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference
                            .version3.1.17.0.0
                            • Values Differ

                            Structure

                            NameL FlagsL Card.L TypeL Description & ConstraintsR FlagsR Card.R TypeR Description & ConstraintsCommentsdoco
                            .. DocumentReference 0..*DocumentReferenceA reference to a document
                            0..*DocumentReferenceA reference to a document
                              ... id Σ0..1stringLogical 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: ?? (preferred): A human language.

                                    Additional BindingsPurpose
                                    ??Max Binding
                                    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 SΣ0..*IdentifierOther identifiers for the document
                                                SΣ0..*IdentifierOther identifiers for the document
                                                  ... status ?!SΣ1..1codecurrent | superseded | entered-in-error
                                                  Binding: ?? (required)
                                                  ?!SΣ1..1codecurrent | superseded | entered-in-error
                                                  Binding: ?? (required)
                                                    ... docStatus Σ0..1codepreliminary | final | 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.

                                                      ... type 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
                                                      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
                                                        ... category SΣ1..*CodeableConceptCategorization of document
                                                        Binding: ?? (extensible): The US Core DocumentReferences Type Value Set is a 'starter set' of categories supported for fetching and storing clinical notes.


                                                        SΣ1..*CodeableConceptCategorization of document
                                                        Slice: Unordered, Open by pattern:$this
                                                        Binding: ?? (example): High-level kind of a clinical document at a macro level.


                                                          ... subject SΣ1..1Reference(US Core 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
                                                            ... date SΣ0..1instantWhen this document reference was createdSΣ0..1instantWhen this document reference was created
                                                              ... author SΣ0..*Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile)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
                                                                ... authenticator 0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document
                                                                  ... custodian S0..1Reference(US Core Organization Profile)Organization which maintains the document0..1Reference(Organization)Organization which maintains the document
                                                                  • Elements differ in definition for mustSupport: 'true' vs 'false'
                                                                  ... relatesTo Σ0..*BackboneElementRelationships to other documents
                                                                  Σ0..*BackboneElementRelationships to other documents
                                                                    .... id 0..1stringUnique id for inter-element referencing0..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 even if unrecognized
                                                                        ?!Σ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Σ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 SΣ1..*BackboneElementDocument referenced
                                                                                  SΣ1..*BackboneElementDocument referenced
                                                                                    .... id 0..1stringUnique id for inter-element referencing0..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 even if unrecognized
                                                                                        ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                          .... attachment SΣC1..1AttachmentWhere to access the document
                                                                                          us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present.
                                                                                          SΣC1..1AttachmentWhere to access the document
                                                                                          us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present.
                                                                                            ..... id 0..1stringUnique id for inter-element referencing0..1stringUnique id for inter-element referencing
                                                                                              ..... Slices for extension 0..*ExtensionAdditional content defined by implementations
                                                                                              Slice: Unordered, Open by value:url
                                                                                              0..*ExtensionAdditional content defined by implementations
                                                                                              Slice: Unordered, Open by value:url
                                                                                                ..... contentType SΣ1..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: ?? (preferred): A human language.

                                                                                                Additional BindingsPurpose
                                                                                                ??Max Binding

                                                                                                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 SC0..1base64BinaryData inline, base64edSC0..1base64BinaryData inline, base64ed
                                                                                                    ..... url SΣC0..1urlUri where the data can be found
                                                                                                    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
                                                                                                      ..... 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 SΣ0..1CodingFormat/content rules for the document
                                                                                                              Binding: ?? (extensible)
                                                                                                              SΣ0..1CodingFormat/content rules for the document
                                                                                                              Binding: ?? (extensible)
                                                                                                                ... context SΣ0..1BackboneElementClinical context of documentSΣ0..1BackboneElementClinical context of document
                                                                                                                  .... id 0..1stringUnique id for inter-element referencing0..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 even if unrecognized
                                                                                                                      ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                                                        .... encounter S0..1Reference(US Core Encounter Profile)Context of the document content
                                                                                                                        S0..1Reference(US Core Encounter Profile)Context of the document content
                                                                                                                          .... 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 SΣ0..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..*Reference(Resource)Related identifiers or resources
                                                                                                                                    0..*Reference(Resource)Related identifiers or resources

                                                                                                                                      doco Documentation for this format