HL7.FHIR.UV.IPA\IPA-DocumentReference

International Patient Access
0.1.0 - STU 1 ballot

This page is part of the International Patient Access (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: IPA-DocumentReference

Defining URL:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference

Version:

0.1.0

Name:

IPADocumentReference

Title:

IPA-DocumentReference

Status:

Draft as of 8/26/19 3:10 PM

Definition:

Minimum expectations for a DocumentReference resource when accessed via a International Patient Access API

Publisher:

HL7 International - Patient Care Workgroup

Copyright:

Creative Commons Public Domain

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-documentreference

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from DocumentReference

Summary

Mandatory: 7 elements
Must-Support: 15 elements

Structures

This structure refers to these other structures:

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	A reference to a document
status	S	1..1	code	current \| superseded \| entered-in-error
type	S	1..1	CodeableConcept	Kind of document (LOINC if possible)
category	S	1..*	CodeableConcept	Categorization of document
subject	S	1..1	Reference(IPA-Patient)	Who/what is the subject of the document
date	S	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
content	S	1..1	BackboneElement	Document referenced
attachment	SI	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.
contentType	S	1..1	code	Mime type of the content, with charset etc.
data	S	0..1	base64Binary	Data inline, base64ed
url	S	0..1	url	Uri where the data can be found
format	S	0..1	Coding	Format/content rules for the document
context	S	0..1	BackboneElement	Clinical context of document
encounter	S	0..1	Reference()	Context of the document content
period	S	0..1	Period	Time of service that is being documented
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	A reference to a document
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current \| superseded \| entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	preliminary \| final \| amended \| entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
category	SΣ	1..*	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (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
date	SΣ	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
authenticator		0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Who/what authenticated the document
custodian		0..1	Reference(Organization)	Organization which maintains the document
relatesTo	Σ	0..*	BackboneElement	Relationships to other documents
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	replaces \| transforms \| signs \| appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship
description	Σ	0..1	string	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣI	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
Slices for extension		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: Mime Types (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: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. Example General: en-AU
data	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
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	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
creation	Σ	0..1	dateTime	Date attachment was first created
format	SΣ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
context	SΣ	0..1	BackboneElement	Clinical context of document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
encounter	S	0..1	Reference()	Context of the document content
event		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	SΣ	0..1	Period	Time of service that is being documented
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo		0..1	Reference(Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	A reference to a document
status	?!Σ	1..1	code	current \| superseded \| entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
type	Σ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
category	Σ	1..*	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
subject	Σ	1..1	Reference(IPA-Patient)	Who/what is the subject of the document
date	Σ	0..1	instant	When this document reference was created
author	Σ	0..*	Reference(IPA-Practitioner \| IPA-PractitionerRole \| IPA-Patient)	Who and/or what authored the document
content	Σ	1..1	BackboneElement	Document referenced
attachment	ΣI	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.
contentType	Σ	1..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
context	Σ	0..1	BackboneElement	Clinical context of document
encounter		0..1	Reference()	Context of the document content
period	Σ	0..1	Period	Time of service that is being documented
Documentation for this format

This structure is derived from DocumentReference

Summary

Mandatory: 7 elements
Must-Support: 15 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	A reference to a document
status	S	1..1	code	current \| superseded \| entered-in-error
type	S	1..1	CodeableConcept	Kind of document (LOINC if possible)
category	S	1..*	CodeableConcept	Categorization of document
subject	S	1..1	Reference(IPA-Patient)	Who/what is the subject of the document
date	S	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
content	S	1..1	BackboneElement	Document referenced
attachment	SI	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.
contentType	S	1..1	code	Mime type of the content, with charset etc.
data	S	0..1	base64Binary	Data inline, base64ed
url	S	0..1	url	Uri where the data can be found
format	S	0..1	Coding	Format/content rules for the document
context	S	0..1	BackboneElement	Clinical context of document
encounter	S	0..1	Reference()	Context of the document content
period	S	0..1	Period	Time of service that is being documented
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
DocumentReference		0..*	DocumentReference	A reference to a document
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!SΣ	1..1	code	current \| superseded \| entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	0..1	code	preliminary \| final \| amended \| entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	SΣ	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
category	SΣ	1..*	CodeableConcept	Categorization of document Binding: DocumentClassValueSet (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
date	SΣ	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
authenticator		0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Who/what authenticated the document
custodian		0..1	Reference(Organization)	Organization which maintains the document
relatesTo	Σ	0..*	BackboneElement	Relationships to other documents
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	replaces \| transforms \| signs \| appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship
description	Σ	0..1	string	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
content	SΣ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	SΣI	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
Slices for extension		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: Mime Types (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: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. Example General: en-AU
data	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
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	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
creation	Σ	0..1	dateTime	Date attachment was first created
format	SΣ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
context	SΣ	0..1	BackboneElement	Clinical context of document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
encounter	S	0..1	Reference()	Context of the document content
event		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	SΣ	0..1	Period	Time of service that is being documented
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo		0..1	Reference(Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
DocumentReference.language	preferred	CommonLanguages Max Binding: AllLanguages
DocumentReference.status	required	DocumentReferenceStatus
DocumentReference.docStatus	required	CompositionStatus
DocumentReference.type	preferred	DocumentTypeValueSet
DocumentReference.category	example	DocumentClassValueSet
DocumentReference.relatesTo.code	required	DocumentRelationshipType
DocumentReference.securityLabel	extensible	All Security Labels
DocumentReference.content.attachment.contentType	required	Mime Types
DocumentReference.content.attachment.language	preferred	CommonLanguages Max Binding: AllLanguages
DocumentReference.content.format	preferred	DocumentReferenceFormatCodeSet
DocumentReference.context.event	example	ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet

Constraints

Id	Path	Details	Requirements
ipa-doc-1	DocumentReference.content.attachment	DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists()