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: '5.0.1' vs '6.0.0-preview'

Metadata

NameValueComments
.abstractfalse
    .baseDefinitionhttp://hl7.org/fhir/StructureDefinition/DocumentReference
      .copyrightUsed by permission of HL7 International, all rights reserved Creative Commons License
        .date2022-04-20
          .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 the mandatory core elements, extensions, vocabularies and value sets which **SHALL** be present in the DocumentReference resource when using this profile. It provides the floor for standards development for specific uses 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.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 the mandatory core elements, extensions, vocabularies and value sets which **SHALL** be present in the DocumentReference resource when using this 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.
          • Values Differ
          .experimentalfalse
            .fhirVersion4.0.1
              .jurisdiction
                ..jurisdiction[0]urn:iso:std:iso:3166#US
                  .kindresource
                    .nameUSCoreDocumentReferenceProfile
                      .publisherHL7 International - Cross-Group Projects
                        .purpose
                          .statusactive
                            .titleUS Core DocumentReference Profile
                              .typeDocumentReference
                                .urlhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference
                                  .version5.0.16.0.0-preview
                                  • Values Differ

                                  Structure

                                  NameL FlagsL Card.L TypeL Description & ConstraintsR FlagsR Card.L TypeL 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: CommonLanguages (preferred): A human language.

                                          Additional BindingsPurpose
                                          AllLanguagesMax Binding
                                          0..1codeLanguage of the resource content
                                          Binding: CommonLanguages (preferred): A human language.

                                          Additional BindingsPurpose
                                          AllLanguagesMax 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: DocumentReferenceStatus (required)
                                                        ?!SΣ1..1codecurrent | superseded | entered-in-error
                                                        Binding: DocumentReferenceStatus (required)
                                                          ... docStatus Σ0..1codepreliminary | final | amended | entered-in-error
                                                          Binding: CompositionStatus (required): Status of the underlying document.

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

                                                            ... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
                                                            Binding: USCoreDocumentReferenceType (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'

                                                            Additional BindingsPurpose
                                                            USCoreClinicalNoteTypeMin Binding
                                                            SΣ1..1CodeableConceptKind of document (LOINC if possible)
                                                            Binding: US Core DocumentReference Type (required): All LOINC values whose SCALE is DOC in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'

                                                            Additional BindingsPurpose
                                                            US Core Clinical Note TypeMin Binding
                                                              ... Slices for category SΣ1..*CodeableConceptCategorization of document
                                                              Slice: Unordered, Open by pattern:$this
                                                              Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


                                                              SΣ1..*CodeableConceptCategorization of document
                                                              Slice: Unordered, Open by pattern:$this
                                                              Binding: DocumentClassValueSet (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)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 S | US Core Organization Profile | US Core Patient Profile | US Core PractitionerRole Profile | http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson | Device)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 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: DocumentRelationshipType (required): The type of relationship between documents.

                                                                                  Σ1..1codereplaces | transforms | signs | appends
                                                                                  Binding: DocumentRelationshipType (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: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


                                                                                        Σ0..*CodeableConceptDocument security-tags
                                                                                        Binding: All Security Labels (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Σ0..1codeMime type of the content, with charset etc.
                                                                                                        Binding: Mime Types (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: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


                                                                                                        Example General: text/plain; charset=UTF-8, image/png
                                                                                                          ..... language Σ0..1codeHuman language of the content (BCP-47)
                                                                                                          Binding: CommonLanguages (preferred): A human language.

                                                                                                          Additional BindingsPurpose
                                                                                                          AllLanguagesMax Binding

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

                                                                                                          Additional BindingsPurpose
                                                                                                          AllLanguagesMax 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: DocumentReferenceFormatCodeSet (extensible)
                                                                                                                        SΣ0..1CodingFormat/content rules for the document
                                                                                                                        Binding: DocumentReferenceFormatCodeSet (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: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


                                                                                                                                    0..*CodeableConceptMain clinical acts documented
                                                                                                                                    Binding: v3 Code System ActCode (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: FacilityTypeCodeValueSet (example): XDS Facility Type.

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

                                                                                                                                          .... practiceSetting 0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
                                                                                                                                          Binding: PracticeSettingCodeValueSet (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: PracticeSettingCodeValueSet (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