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

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

Messages

ErrorStructureDefinition.urlValues for url differ: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference' vs 'http://hl7.org/fhir/us/spl/StructureDefinition/SPLDocumentReference'
ErrorStructureDefinition.versionValues for version differ: '7.0.0' vs '0.1.0'
InformationStructureDefinition.nameValues for name differ: 'USCoreDocumentReferenceProfile' vs 'SPLDocumentReference'
InformationStructureDefinition.dateValues for date differ: '2023-10-17' vs '2024-05-16T19:43:56+00:00'
InformationStructureDefinition.publisherValues for publisher differ: 'HL7 International / Cross-Group Projects' vs 'HL7 International / Biomedical Research and Regulation'
WarningStructureDefinition.fhirVersionValues for fhirVersion differ: '4.0.1' vs '4.3.0'
InformationDocumentReference.containedStructureDefinition SPLDocumentReference has added constraint that is not found in USCoreDocumentReferenceProfile and it is uncertain whether they are compatible (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
InformationStructureDefinition.shortValues for short differ: 'Additional content defined by implementations' vs 'Extension'
InformationStructureDefinition.definitionValues for definition differ: '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.' vs 'An Extension'
InformationStructureDefinition.requirementsValues for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).'
WarningDocumentReference.masterIdentifierElements differ in definition for mustSupport: 'false' vs 'true'
InformationDocumentReference.masterIdentifierElement minimum cardinalities differ: '0' vs '1'
InformationDocumentReference.identifierElement minimum cardinalities differ: '0' vs '1'
WarningDocumentReference.statusElements differ in definition for mustSupport: 'true' vs 'false'
ErrorDocumentReference.docStatusUnable to resolve left value set http://hl7.org/fhir/ValueSet/composition-status|4.0.1 at DocumentReference.docStatus
WarningDocumentReference.categoryElements differ in definition for mustSupport: 'true' vs 'false'
InformationDocumentReference.categoryElement minimum cardinalities differ: '1' vs '0'
WarningDocumentReference.subjectElements differ in definition for mustSupport: 'true' vs 'false'
InformationDocumentReference.subjectElement minimum cardinalities differ: '1' vs '0'
InformationDocumentReference.dateElement minimum cardinalities differ: '0' vs '1'
WarningDocumentReference.authorElements differ in definition for mustSupport: 'true' vs 'false'
InformationStructureDefinition.requirementsValues for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).'
ErrorDocumentReference.relatesTo.codeUnable to resolve left value set http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 at DocumentReference.relatesTo.code
InformationStructureDefinition.requirementsValues for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).'
InformationStructureDefinition.definitionValues for definition differ: 'The document and format referenced.' vs 'The document or URL of the document along with critical metadata to prove content has integrity.'
ErrorDocumentReference.content.attachment.contentTypeUnable to resolve left value set http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 at DocumentReference.content.attachment.contentType
InformationDocumentReference.content.attachment.dataElement minimum cardinalities differ: '0' vs '1'
WarningDocumentReference.content.attachment.urlElements differ in definition for mustSupport: 'true' vs 'false'
WarningDocumentReference.content.formatElements differ in definition for mustSupport: 'true' vs 'false'
WarningDocumentReference.contextElements differ in definition for mustSupport: 'true' vs 'false'
InformationStructureDefinition.requirementsValues for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4B/extensibility.html#modifierExtension).'
WarningDocumentReference.context.encounterElements differ in definition for mustSupport: 'true' vs 'false'
InformationDocumentReference.context.encounterElement maximum cardinalities differ: '1' vs '2147483647'
WarningDocumentReference.context.periodElements differ in definition for mustSupport: 'true' vs 'false'

Metadata

NameValueComments
.abstractfalse
    .baseDefinitionhttp://hl7.org/fhir/StructureDefinition/DocumentReference
      .copyrightUsed by permission of HL7 International, all rights reserved Creative Commons License
      • Removed the item 'Used by permission of HL7 International, all rights reserved Creative Commons License'
      .date2023-10-172024-05-16T19:43:56+00:00
      • Values Differ
      .descriptionThe 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.A profile that represents the SPL document that was either created by or was the source for the Organization FHIR Bundle.
      • Values Differ
      .experimentalfalse
      • Removed the item 'false'
      .fhirVersion4.0.14.3.0
      • Values Differ
      .jurisdiction
        ..jurisdiction[0]urn:iso:std:iso:3166#US
          .kindresource
            .nameUSCoreDocumentReferenceProfileSPLDocumentReference
            • Values Differ
            .publisherHL7 International / Cross-Group ProjectsHL7 International / Biomedical Research and Regulation
            • Values Differ
            .purpose
              .statusactive
                .titleUS Core DocumentReference Profile
                • Removed the item 'US Core DocumentReference Profile'
                .typeDocumentReference
                  .urlhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreferencehttp://hl7.org/fhir/us/spl/StructureDefinition/SPLDocumentReference
                  • Values Differ
                  .version7.0.00.1.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..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
                          ... 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
                            dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
                            • StructureDefinition SPLDocumentReference has added constraint that is not found in USCoreDocumentReferenceProfile and it is uncertain whether they are compatible (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                            ... extension 0..*ExtensionAdditional content defined by implementations
                            0..*ExtensionExtension
                            Slice: Unordered, Open by value:url
                              ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
                              ?!0..*ExtensionExtensions that cannot be ignored
                                ... masterIdentifier Σ0..1IdentifierMaster Version Specific IdentifierSΣ1..1IdentifierMaster Version Specific Identifier
                                • Elements differ in definition for mustSupport: 'false' vs 'true'
                                • Element minimum cardinalities differ: '0' vs '1'
                                ... identifier SΣ0..*IdentifierOther identifiers for the document
                                SΣ1..*IdentifierOther identifiers for the document
                                • Element minimum cardinalities differ: '0' vs '1'
                                ... status ?!SΣ1..1codecurrent | superseded | entered-in-error
                                Binding: ?? (required)
                                ?!Σ1..1codecurrent | superseded | entered-in-error
                                Binding: ?? (required): The status of the document reference.


                                Required Pattern: current
                                • Elements differ in definition for mustSupport: 'true' vs 'false'
                                ... 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.

                                • Unable to resolve left value set http://hl7.org/fhir/ValueSet/composition-status|4.0.1 at DocumentReference.docStatus
                                ... 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: ?? (preferred): Precise type of clinical document.

                                  ... 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.


                                  Σ0..*CodeableConceptCategorization of document
                                  Binding: ?? (example): High-level kind of a clinical document at a macro level.


                                  • Elements differ in definition for mustSupport: 'true' vs 'false'
                                  • Element minimum cardinalities differ: '1' vs '0'
                                  ... subject SΣ1..1Reference(US Core Patient Profile S | Practitioner | Group | Device)Who/what is the subject of the documentΣ0..1Reference(Patient | Practitioner | Group | Device)Who/what is the subject of the document
                                  • Elements differ in definition for mustSupport: 'true' vs 'false'
                                  • Element minimum cardinalities differ: '1' vs '0'
                                  ... date SΣ0..1instantWhen this document reference was createdSΣ1..1instantWhen this document reference was created
                                  • Element minimum cardinalities differ: '0' vs '1'
                                  ... author 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
                                  Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
                                  • Elements differ in definition for mustSupport: 'true' vs 'false'
                                  ... authenticator 0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document0..1Reference(Practitioner | PractitionerRole | Organization)Who/what authenticated the document
                                    ... custodian 0..1Reference(Organization)Organization which maintains the document0..1Reference(Organization)Organization which maintains the document
                                      ... 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.

                                              • Unable to resolve left value set http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 at DocumentReference.relatesTo.code
                                              .... 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Σ1..1AttachmentWhere to access the document
                                                              ..... id 0..1stringUnique id for inter-element referencing0..1idUnique 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Σ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
                                                                  SΣ0..1codeMime type of the content, with charset etc.
                                                                  Binding: ?? (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


                                                                  Example General: text/plain; charset=UTF-8, image/png
                                                                  • Unable to resolve left value set http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 at DocumentReference.content.attachment.contentType
                                                                  ..... 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): IETF language tag

                                                                  Additional BindingsPurpose
                                                                  ??Max Binding

                                                                  Example General: en-AU
                                                                    ..... data SC0..1base64BinaryData inline, base64edS1..1base64BinaryData inline, base64ed
                                                                    • Element minimum cardinalities differ: '0' vs '1'
                                                                    ..... url SΣC0..1urlUri where the data can be found
                                                                    Example General: http://www.acme.com/logo-small.png
                                                                    Σ0..1urlUri where the data can be found
                                                                    Example General: http://www.acme.com/logo-small.png
                                                                    • Elements differ in definition for mustSupport: 'true' vs 'false'
                                                                    ..... 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)
                                                                            Σ0..1CodingFormat/content rules for the document
                                                                            Binding: ?? (preferred): Document Format Codes.

                                                                            • Elements differ in definition for mustSupport: 'true' vs 'false'
                                                                            ... context SΣ0..1BackboneElementClinical context of documentΣ0..1BackboneElementClinical context of document
                                                                            • Elements differ in definition for mustSupport: 'true' vs 'false'
                                                                            .... 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
                                                                                  0..*Reference(Encounter | EpisodeOfCare)Context of the document content
                                                                                  • Elements differ in definition for mustSupport: 'true' vs 'false'
                                                                                  • Element maximum cardinalities differ: '1' vs '2147483647'
                                                                                  .... 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 documentedΣ0..1PeriodTime of service that is being documented
                                                                                    • Elements differ in definition for mustSupport: 'true' vs 'false'
                                                                                    .... 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