Left: | IPA-DocumentReference (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference) |
Right: | BeDocumentReference (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-documentreference) |
Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference' vs 'https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-documentreference' |
Error | StructureDefinition.version | Values for version differ: '1.0.0' vs '2.1.2' |
Information | StructureDefinition.name | Values for name differ: 'IPADocumentReference' vs 'BeDocumentReference' |
Information | StructureDefinition.title | Values for title differ: 'IPA-DocumentReference' vs 'BeDocumentReference' |
Information | StructureDefinition.date | Values for date differ: '2022-08-02' vs '2024-08-30T17:36:02+02:00' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International - Patient Care Work Group' vs 'eHealth Platform' |
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#BE' |
Warning | DocumentReference.status | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | DocumentReference.type | Elements differ in definition for mustSupport: 'true' vs 'false' |
Warning | DocumentReference.date | Elements differ in definition for mustSupport: 'true' vs 'false' |
Information | DocumentReference.author | Element minimum cardinalities differ: '0' vs '1' |
Information | DocumentReference.author | Element maximum cardinalities differ: '2147483647' vs '1' |
Error | DocumentReference.author | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner], CanonicalType[http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole], CanonicalType[http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-patient]]) vs Reference([CanonicalType[https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization], CanonicalType[https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner], CanonicalType[https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole], CanonicalType[https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient], CanonicalType[http://hl7.org/fhir/StructureDefinition/Device], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson]]) |
Information | StructureDefinition.comment | Values for comment differ: 'The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.' vs 'The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.' |
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' |
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' |
Warning | DocumentReference.context.related | Elements differ in definition for mustSupport: 'false' vs 'true' |
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 |
| |
date | 2022-08-02 | 2024-08-30T17:36:02+02:00 |
|
description | Minimum expectations for a DocumentReference resource when accessed via a International Patient Access API | Belgian federal profile on DocumentReference (see also remark in [Guidance](./guidance.html#bedocumentreference) ) |
|
experimental | false |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |
| |
jurisdiction[1] | urn:iso:std:iso:3166#BE |
| |
kind | resource | ||
name | IPADocumentReference | BeDocumentReference |
|
publisher | HL7 International - Patient Care Work Group | eHealth Platform |
|
purpose | |||
status | active | ||
title | IPA-DocumentReference | BeDocumentReference |
|
type | DocumentReference | ||
url | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference | https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-documentreference |
|
version | 1.0.0 | 2.1.2 |
|
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.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
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 | Σ | 0..* | Identifier | Other identifiers for the document | |||||||||
status | ?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. |
| ||||||||
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 | SΣ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. | Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document. |
| ||||||||
category | SΣ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. | SΣ | 0..* | CodeableConcept | Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level. | |||||||||
subject | SΣ | 1..1 | Reference(IPA-Patient) | Who/what is the subject of the document | SΣ | 1..1 | Reference(BePatient) | Who/what is the subject of the document | |||||||||
date | SΣ | 0..1 | instant | When this document reference was created | Σ | 0..1 | instant | When this document reference was created |
| ||||||||
author | SΣ | 0..* | Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Patient) | Who and/or what authored the document | SΣ | 1..1 | Reference(BeOrganization | BePractitioner | BePractitionerRole | BePatient | Device | RelatedPerson) | 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 | SΣ | 1..* | BackboneElement | Document referenced | 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 | SΣC | 1..1 | Attachment | Where to access the document ipa-doc-1: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. | SΣ | 1..1 | Attachment | Where to access the document | |||||||||
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 | SΣ | 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 | SΣ | 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 | |||||||||
language | Σ | 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): A human language.
Example General: en-AU | |||||||||
data | S | 0..1 | base64Binary | Data inline, base64ed | S | 0..1 | base64Binary | Data inline, base64ed | |||||||||
url | SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | SΣ | 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 | SΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. | Σ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes. |
| ||||||||
context | SΣ | 0..1 | BackboneElement | Clinical context of document | Σ | 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 | S | 0..1 | Reference(Encounter | EpisodeOfCare) | Context of the document content | 0..* | Reference(Encounter | EpisodeOfCare) | 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 | SΣ | 0..1 | Period | Time of service that is being documented | Σ | 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 | S | 0..* | Reference(Resource) | Related identifiers or resources |
| |||||||||
Documentation for this format |