abstractbaseDefinitioncopyrightdatedescriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisher- Values Differ
purposestatustitletypeurlversion- Values Differ
| Left: | IPA-DocumentReference (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference) |
| Right: | IPA-DocumentReference (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference) |
| Error | StructureDefinition.version | Values for version differ: '1.0.0' vs '1.1.0' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International - Patient Care Work Group' vs 'HL7 International / Patient Care' |
| 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 | ||
| description | Minimum expectations for a DocumentReference resource when accessed via a International Patient Access API | ||
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
| kind | resource | ||
| name | IPADocumentReference | ||
| publisher | HL7 International - Patient Care Work Group | HL7 International / Patient Care |
|
| purpose | |||
| status | active | ||
| title | IPA-DocumentReference | ||
| type | DocumentReference | ||
| url | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference | ||
| version | 1.0.0 | 1.1.0 |
|
| 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. | ?!SOΣ | 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. | SOΣ | 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. | SOΣ | 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 | SOΣ | 1..1 | Reference(IPA-Patient) | Who/what is the subject of the document
| |||||||||
| date | SΣ | 0..1 | instant | When this document reference was created | SOΣ | 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 | SOΣ | 0..* | Reference(IPA-Practitioner | IPA-PractitionerRole | Organization | Device | IPA-Patient | 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 | SOΣ | 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. | SOΣ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.
| |||||||||
| 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 | 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
| |||||||||
| 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 | SO | 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 | SOΣ | 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. | SOΣ | 0..1 | Coding | Format/content rules for the document Binding: ?? (preferred): Document Format Codes.
| |||||||||
 context | SΣ | 0..1 | BackboneElement | Clinical context of document | SOΣ | 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 | SO | 0..1 | 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 | SOΣ | 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 | |||||||||||||||||