Profile Comparison between http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference vs http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-documentreference

Messages

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		Removed the item 'Used by permission of HL7 International all rights reserved Creative Commons License'
date	2022-08-02	2024-08-09	Values Differ
description	Minimum expectations for a DocumentReference resource when accessed via a International Patient Access API	Proposed constraints on the DocumentReference resource for the minimal set of data required to reference to a document of any kind for any purpose.	Values Differ
experimental	false		Removed the item '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#CA	Added the item 'urn:iso:std:iso:3166#CA'
kind	resource
name	IPADocumentReference	DocumentReferenceProfile	Values Differ
publisher	HL7 International / Patient Care	HL7 Canada - FHIR Implementation Work Group	Values Differ
purpose
status	active	draft	Values Differ
title	IPA-DocumentReference	DocumentReference Profile for metadata about the document	Values Differ
type	DocumentReference
url	http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference	http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-documentreference	Values Differ
version	1.1.0	1.2.0	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	DocumentReference Profile
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
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	SΣ	0..1	Identifier	Master Version Specific Identifier	Elements differ in definition for mustSupport: 'false' vs 'true'
identifier	Σ	0..*	Identifier	Other identifiers for the document	Σ	0..*	Identifier	Other identifiers for the document
status	?!SOΣ	1..1	code	current | superseded | entered-in-error Binding: ?? (required): The status of the document reference. Obligations Actor SHALL:populate-if-known http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	?!Σ	1..1	code	current | superseded | entered-in-error Binding: ?? (required): The status of the document reference.	Elements differ in definition for mustSupport: 'true' vs 'false'
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	SΣ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: ?? (preferred): Precise type of clinical document.
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHOULD:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	SΣ	0..*	CodeableConcept	Categorization of document Binding: ?? (example): High-level kind of a clinical document at a macro level.
subject	SOΣ	1..1	Reference(IPA-Patient)	Who/what is the subject of the document Obligations Actor SHALL:populate-if-known http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	SΣ	0..1	Reference(Patient Profile | Practitioner Profile (General) | Device Profile (Implantable))	Who/what is the subject of the document	Element minimum cardinalities differ: '1' vs '0'
date	SOΣ	0..1	instant	When this document reference was created Obligations Actor SHALL:populate-if-known http://hl7.org/fhir/uv/ipa/ActorDefinition/server	Σ	0..1	instant	When this document reference was created	Elements differ in definition for mustSupport: 'true' vs 'false'
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHOULD:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	SΣ	0..*	Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Organization Profile | Device Profile (Implantable) | Patient Profile)	Who and/or what authored the document
authenticator		0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document	S	0..1	Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Organization Profile)	Who/what authenticated the document	Elements differ in definition for mustSupport: 'false' vs 'true'
custodian		0..1	Reference(Organization)	Organization which maintains the document	S	0..1	Reference(Organization Profile)	Organization which maintains the document	Elements differ in definition for mustSupport: 'false' vs 'true'
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	Σ	1..*	BackboneElement	Document referenced	Elements differ in definition for mustSupport: 'true' vs 'false'
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 ipa-doc-1: DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. Obligations Actor SHALL:populate-if-known http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	SΣC	1..1	Attachment	Where to access the document ca-baseline-documentreference-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					Removed this element
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url					Removed this element
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client					Removed this element
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					Removed this element
data	SO	0..1	base64Binary	Data inline, base64ed Obligations Actor SHALL:populate-if-known http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client					Removed this element
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client					Removed this element
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)					Removed this element
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)					Removed this element
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo					Removed this element
creation	Σ	0..1	dateTime	Date attachment was first created					Removed this element
format	SOΣ	0..1	Coding	Format/content rules for the document Binding: ?? (preferred): Document Format Codes. Obligations Actor SHALL:populate-if-known http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	Σ	0..1	Coding	Format/content rules for the document Binding: ?? (preferred): Document Format Codes.	Elements differ in definition for mustSupport: 'true' vs 'false'
context	SOΣ	0..1	BackboneElement	Clinical context of document Obligations Actor SHALL:populate-if-known http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	Σ	0..1	BackboneElement	Clinical context of document	Elements differ in definition for mustSupport: 'true' vs 'false'
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	S	0..*	Reference(Encounter Profile)	Context of the document content	Element maximum cardinalities differ: '1' vs '2147483647'
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 http://hl7.org/fhir/uv/ipa/ActorDefinition/server SHALL:handle http://hl7.org/fhir/uv/ipa/ActorDefinition/client	Σ	0..1	Period	Time of service that is being documented	Elements differ in definition for mustSupport: 'true' vs 'false'
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).	S	0..1	CodeableConcept	PractitionerSpecialty Binding: ?? (preferred): Defines the clinical, medical, surgical or other healthcare-related service specialty of a practitioner who interacts, treats or provides such services to or for a patient.	Elements differ in definition for mustSupport: 'false' vs 'true' Example/preferred bindings differ at DocumentReference.context.practiceSetting using binding from DocumentReferenceProfile
sourcePatientInfo		0..1	Reference(Patient)	Patient demographics from source	S	0..1	Reference(Patient Profile)	Patient demographics from source	Elements differ in definition for mustSupport: 'false' vs 'true'
related		0..*	Reference(Resource)	Related identifiers or resources		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format