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) |
Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference' vs 'http://hl7.org/fhir/us/spl/StructureDefinition/SPLDocumentReference' |
Error | StructureDefinition.version | Values for version differ: '7.0.0' vs '0.1.0' |
Information | StructureDefinition.name | Values for name differ: 'USCoreDocumentReferenceProfile' vs 'SPLDocumentReference' |
Information | StructureDefinition.date | Values for date differ: '2023-10-17' vs '2024-05-16T19:43:56+00:00' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Cross-Group Projects' vs 'HL7 International / Biomedical Research and Regulation' |
Warning | StructureDefinition.fhirVersion | Values for fhirVersion differ: '4.0.1' vs '4.3.0' |
Information | DocumentReference.contained | 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)) |
Information | StructureDefinition.short | Values for short differ: 'Additional content defined by implementations' vs 'Extension' |
Information | StructureDefinition.definition | Values 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' |
Information | StructureDefinition.requirements | Values 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).' |
Warning | DocumentReference.masterIdentifier | Elements differ in definition for mustSupport: 'false' vs 'true' |
Information | DocumentReference.masterIdentifier | Element minimum cardinalities differ: '0' vs '1' |
Information | DocumentReference.identifier | Element minimum cardinalities differ: '0' vs '1' |
Warning | DocumentReference.status | Elements differ in definition for mustSupport: 'true' vs 'false' |
Error | DocumentReference.docStatus | Unable to resolve left value set http://hl7.org/fhir/ValueSet/composition-status|4.0.1 at DocumentReference.docStatus |
Warning | DocumentReference.category | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | DocumentReference.category | Element minimum cardinalities differ: '1' vs '0' |
Warning | DocumentReference.subject | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | DocumentReference.subject | Element minimum cardinalities differ: '1' vs '0' |
Information | DocumentReference.date | Element minimum cardinalities differ: '0' vs '1' |
Warning | DocumentReference.author | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.requirements | Values 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).' |
Error | DocumentReference.relatesTo.code | Unable to resolve left value set http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 at DocumentReference.relatesTo.code |
Information | StructureDefinition.requirements | Values 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).' |
Information | StructureDefinition.definition | Values 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.' |
Error | DocumentReference.content.attachment.contentType | Unable to resolve left value set http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 at DocumentReference.content.attachment.contentType |
Information | DocumentReference.content.attachment.data | Element minimum cardinalities differ: '0' vs '1' |
Warning | DocumentReference.content.attachment.url | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | DocumentReference.content.format | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | DocumentReference.context | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | StructureDefinition.requirements | Values 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).' |
Warning | DocumentReference.context.encounter | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | DocumentReference.context.encounter | Element maximum cardinalities differ: '1' vs '2147483647' |
Warning | DocumentReference.context.period | Elements differ in definition for mustSupport: 'true' vs 'false' |
Name | Value | Comments | |
---|---|---|---|
![]() | false | ||
![]() | http://hl7.org/fhir/StructureDefinition/DocumentReference | ||
![]() | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
![]() | 2023-10-17 | 2024-05-16T19:43:56+00:00 |
|
![]() | 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. | A profile that represents the SPL document that was either created by or was the source for the Organization FHIR Bundle. |
|
![]() | false |
| |
![]() | 4.0.1 | 4.3.0 |
|
![]() | |||
![]() ![]() | urn:iso:std:iso:3166#US | ||
![]() | resource | ||
![]() | USCoreDocumentReferenceProfile | SPLDocumentReference |
|
![]() | HL7 International / Cross-Group Projects | HL7 International / Biomedical Research and Regulation |
|
![]() | |||
![]() | active | ||
![]() | US Core DocumentReference Profile |
| |
![]() | DocumentReference | ||
![]() | http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | http://hl7.org/fhir/us/spl/StructureDefinition/SPLDocumentReference |
|
![]() | 7.0.0 | 0.1.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | DocumentReference | A reference to a document | 0..* | DocumentReference | A reference to a document | |||||||||||
![]() ![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() ![]() | ?!Σ | 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 | |||||||||
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): IETF language tag
| |||||||||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
| ||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Master Version Specific Identifier | SΣ | 1..1 | Identifier | Master Version Specific Identifier |
| ||||||||
![]() ![]() ![]() | SΣ | 0..* | Identifier | Other identifiers for the document | SΣ | 1..* | Identifier | Other identifiers for the document |
| ||||||||
![]() ![]() ![]() | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required) | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. Required Pattern: current |
| ||||||||
![]() ![]() ![]() | Σ | 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. |
| ||||||||
![]() ![]() ![]() | 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'
| SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. | |||||||||
![]() ![]() ![]() | SΣ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by pattern:$this Binding: ?? (example): High-level kind of a clinical document at a macro level. | Σ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. |
| ||||||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(US Core Patient Profile S | Practitioner | Group | Device) | Who/what is the subject of the document | Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document |
| ||||||||
![]() ![]() ![]() | SΣ | 0..1 | instant | When this document reference was created | SΣ | 1..1 | instant | When this document reference was created |
| ||||||||
![]() ![]() ![]() | 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 |
| ||||||||
![]() ![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||||||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | Organization which maintains the document | 0..1 | Reference(Organization) | Organization which maintains the document | |||||||||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Relationships to other documents | Σ | 0..* | BackboneElement | Relationships to other documents | |||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() ![]() | Σ | 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. |
| ||||||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | |||||||||
![]() ![]() ![]() | Σ | 0..1 | string | Human-readable description | Σ | 0..1 | string | Human-readable description | |||||||||
![]() ![]() ![]() | Σ | 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. | |||||||||
![]() ![]() ![]() | SΣ | 1..* | BackboneElement | Document referenced | SΣ | 1..* | BackboneElement | Document referenced | |||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() ![]() | SΣC | 1..1 | Attachment | Where to access the document us-core-6: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | SΣ | 1..1 | Attachment | Where to access the document | |||||||||
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | id | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() ![]() | 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 | |||||||||||
![]() ![]() ![]() ![]() ![]() | 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 | SΣ | 0..1 | code | Mime 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 |
| ||||||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): A human language.
Example General: en-AU | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: ?? (preferred): IETF language tag
Example General: en-AU | |||||||||
![]() ![]() ![]() ![]() ![]() | SC | 0..1 | base64Binary | Data inline, base64ed | S | 1..1 | base64Binary | Data inline, base64ed |
| ||||||||
![]() ![]() ![]() ![]() ![]() | SΣC | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| ||||||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | |||||||||
![]() ![]() ![]() ![]() ![]() | Σ | 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 | |||||||||
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | dateTime | Date attachment was first created | Σ | 0..1 | dateTime | Date attachment was first created | |||||||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (extensible) | Σ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. |
| ||||||||
![]() ![]() ![]() | SΣ | 0..1 | BackboneElement | Clinical context of document | Σ | 0..1 | BackboneElement | Clinical context of document |
| ||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() ![]() | S | 0..1 | Reference(US Core Encounter Profile) | Context of the document content | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content |
| |||||||||
![]() ![]() ![]() ![]() | 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. | |||||||||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time of service that is being documented | Σ | 0..1 | Period | Time of service that is being documented |
| ||||||||
![]() ![]() ![]() ![]() | 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. | |||||||||||
![]() ![]() ![]() ![]() | 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). | |||||||||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Patient) | Patient demographics from source | 0..1 | Reference(Patient) | Patient demographics from source | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Reference(Resource) | Related identifiers or resources | 0..* | Reference(Resource) | Related identifiers or resources | |||||||||||
![]() |