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

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

### Messages

Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference'
Error | StructureDefinition.version | Values for version differ: '1.1.0' vs '8.0.1'
Information | StructureDefinition.name | Values for name differ: 'IPADocumentReference' vs 'USCoreDocumentReferenceProfile'
Information | StructureDefinition.title | Values for title differ: 'IPA-DocumentReference' vs 'US Core DocumentReference Profile'
Information | StructureDefinition.date | Values for date differ: '2022-08-02' vs '2023-10-17'
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 International / Cross-Group Projects'
Information | StructureDefinition.copyright | Values for copyright differ: 'Used by permission of HL7 International all rights reserved Creative Commons License' vs 'Used by permission of HL7 International, all rights reserved Creative Commons License'
Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#US'
Information | DocumentReference.language | Example/preferred bindings differ at DocumentReference.language using binding from IPADocumentReference
Warning | DocumentReference.identifier | Elements differ in definition for mustSupport: 'false' vs 'true'
Information | DocumentReference.type | Element minimum cardinalities differ: '0' vs '1'
Information | DocumentReference.category | Element minimum cardinalities differ: '0' vs '1'
Information | StructureDefinition.definition | Values for definition differ: 'The document or URL of the document along with critical metadata to prove content has integrity.' vs 'The document and format referenced.'
Information | DocumentReference.content.attachment.contentType | Element minimum cardinalities differ: '1' vs '0'
Information | DocumentReference.content.attachment.language | Example/preferred bindings differ at DocumentReference.content.attachment.language using binding from IPADocumentReference

### Metadata

Name | Value | Comments
--- | --- | ---
abstract | false |
baseDefinition | http://hl7.org/fhir/StructureDefinition/DocumentReference |
copyright | Used by permission of HL7 International all rights reserved Creative Commons License | Used by permission of HL7 International, all rights reserved Creative Commons License | Values Differ
date | 2022-08-02 | 2023-10-17 | Values Differ
description | Minimum expectations for a DocumentReference resource when accessed via a International Patient Access API | 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
experimental | false |
fhirVersion | 4.0.1 |
jurisdiction |  |
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |  | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
jurisdiction[1] |  | urn:iso:std:iso:3166#US | Added the item 'urn:iso:std:iso:3166#US'
kind | resource |
name | IPADocumentReference | USCoreDocumentReferenceProfile | Values Differ
publisher | HL7 International / Patient Care | HL7 International / Cross-Group Projects | Values Differ
purpose |  |
status | active |
title | IPA-DocumentReference | US Core DocumentReference Profile | Values Differ
type | DocumentReference |
url | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | Values Differ
version | 1.1.0 | 8.0.1 | Values Differ

### Structure

Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
DocumentReference |  | 0..* | DocumentReference | A reference to a document |  | 0..* | DocumentReference | A reference to a document |
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language |  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
|  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
| Example/preferred bindings differ at DocumentReference.language using binding from IPADocumentReference
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
contained |  | 0..* | Resource | Contained, inline Resources |  | 0..* | Resource | Contained, inline Resources |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored |
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | Σ | 0..1 | Identifier | Master Version Specific Identifier |
identifier | Σ | 0..* | Identifier | Other identifiers for the document | S Σ | 0..* | Identifier | Other identifiers for the document | Elements differ in definition for mustSupport: 'false' vs 'true'
status | ?!SO Σ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference.
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| ?!S Σ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required) |
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required): Status of the underlying document. | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: ?? (required): Status of the underlying document. |
type | SO Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document.
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (required): All LOINC values whose SCALE is "Doc" in the LOINC database and the HL7 v3 Code System NullFlavor concept 'unknown'
Additional Bindings | Purpose
?? | Min Binding
| Element minimum cardinalities differ: '0' vs '1'
category | SO Σ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level.
Obligations | Actor
SHALL:populate-if-known | Server
SHOULD:handle | Client
| S Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ?? (example): High-level kind of a clinical document at a macro level. | Element minimum cardinalities differ: '0' vs '1'
subject | SO Σ | 1..1 | Reference(IPA-Patient) | Who/what is the subject of the document
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ | 1..1 | Reference(US Core Patient Profile S | Practitioner | Group | Device) | Who/what is the subject of the document |
date | SO Σ | 0..1 | instant | When this document reference was created
Obligations | Actor
SHALL:populate-if-known | Server
| S Σ | 0..1 | instant | When this document reference was created |
author | SO Σ | 0..* | Reference(IPA-Practitioner | IPA-PractitionerRole | Organization | Device | IPA-Patient | RelatedPerson) | Who and/or what authored the document
Obligations | Actor
SHALL:populate-if-known | Server
SHOULD:handle | Client
| 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..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document |  | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document |
custodian |  | 0..1 | Reference(Organization) | Organization which maintains the document |  | 0..1 | Reference(Organization) | Organization which maintains the document |
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | Σ | 0..* | BackboneElement | Relationships to other documents |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: ?? (required): The type of relationship between documents. | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: ?? (required): The type of relationship between documents. |
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
description | Σ | 0..1 | string | Human-readable description | Σ | 0..1 | string | Human-readable description |
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | CodeableConcept | Document security-tags Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
content | SO Σ | 1..* | BackboneElement | Document referenced
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ | 1..* | BackboneElement | Document referenced |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | SO Σ C | 1..1 | Attachment | Where to access the document Constraints: ipa-doc-1
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ C | 1..1 | Attachment | Where to access the document Constraints: us-core-6 |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
contentType | SO Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ | 0..1 | code | Mime type of the content, with charset etc. Binding: ?? (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | Element minimum cardinalities differ: '1' vs '0'
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
Example General: en-AU | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
Example General: en-AU | Example/preferred bindings differ at DocumentReference.content.attachment.language using binding from IPADocumentReference
data | SO | 0..1 | base64Binary | Data inline, base64ed
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S C | 0..1 | base64Binary | Data inline, base64ed |
url | SO Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ C | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) |
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
creation | Σ | 0..1 | dateTime | Date attachment was first created | Σ | 0..1 | dateTime | Date attachment was first created |
format | SO Σ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes.
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ | 0..1 | Coding | Format/content rules for the document Binding: ?? (extensible) |
context | SO Σ | 0..1 | BackboneElement | Clinical context of document
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ | 0..1 | BackboneElement | Clinical context of document |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
encounter | SO | 0..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content |
event |  | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. |  | 0..* | CodeableConcept | Main clinical acts documented Binding: ?? (example): This list of codes represents the main clinical acts being documented. |
period | SO Σ | 0..1 | Period | Time of service that is being documented
Obligations | Actor
SHALL:populate-if-known | Server
SHALL:handle | Client
| S Σ | 0..1 | Period | Time of service that is being documented |
facilityType |  | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. |  | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: ?? (example): XDS Facility Type. |
practiceSetting |  | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). |  | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: ?? (example): Additional details about where the content was created (e.g. clinical specialty). |
sourcePatientInfo |  | 0..1 | Reference(Patient) | Patient demographics from source |  | 0..1 | Reference(Patient) | Patient demographics from source |
related |  | 0..* | Reference(Resource) | Related identifiers or resources |  | 0..* | Reference(Resource) | Related identifiers or resources |
Documentation for this format