HL7.FHIR.US.PACIO-ADI\PADI CapabilityStatement

PACIO Advance Directive Interoperability Implementation Guide
0.0.1 - STU1

PACIO Advance Directive Interoperability Implementation Guide - Local Development build (v0.0.1). See the Directory of published versions

CapabilityStatement: PADI CapabilityStatement

Raw OpenAPI-Swagger Definition file | Download

PADI CapabilityStatement

Implementation Guide Version: 0.0.1
FHIR Version: 4.0.1
Supported formats: xml, json
Published: 2021-05-13
Published by: HL7 Patient Empowerment Working Group (PE WG)

This Section describes the expected capabilities of the PACIO Advance Directive Interoperability (ADI) Server actor which is responsible for providing responses to the queries submitted by the ADI Requestors.

There are two primary vehicles in which Advance Directive Information can be conveyed: DocumentReference and Composition. Through a DocumentReference, the ADI may be encoded inside directly as content data or referred to through a content reference (pointing to the ADI included in a resource like Binary). Through a Composition, the complete document may be retrieved through a $document operation or its referred to entries retrieved directly. The resources referred to by the composition resource include Observation, Organization, RelatedPerson, Consent, List, and Provenance.

[TODO] Additional guidance on general use

FHIR RESTful Capabilities

The ADI Server SHALL:

Support all profiles defined in this Implementation Guide.
Implement the RESTful behavior according to the FHIR specification.
Return the following response classes:
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
- (Status 404): unknown resource
- (Status 410): deleted resource.
Support json source formats for all ADI interactions.
Support the searchParameters on each profile individually and in combination.

The ADI Server SHOULD:

Support xml source formats for all ADI interactions.

Security:

See the Guidance section for requirements and recommendations.
A server SHALL reject any unauthorized requests by returning an 'HTTP 401' unauthorized response code.

RESTful Capabilities by Resource/Profile:

Summary of Search Criteria

Resource Type Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations

Composition PADI-Header, PADI-PACPComposition _id, attester, author, category, confidentiality, context, date, encounter, entry, identifier, patient, period, related-id, related-ref, section, status, subject, title, type

Consent PADI-HealthcareAgentAuthority, PADI-ConsentForHealthcareAgent _id, action, actor, category, consentor, data, date, identifier, organization, patient, period, purpose, scope, security-label, source-reference, status

DocumentReference PADI-DocumentReference _id, authenticator, author, category, contenttype, custodian, date, description, encounter, event, facility, format, identifier, language, location, patient, period, related, relatesto, relation, relationship, security-label, setting, status, subject, type

Goal PADI-PersonalHealthGoal _id, achievement-status, category, identifier, lifecycle-status, patient, start-date, subject, target-date

List PADI-PersonalPrioritiesOrganizer _id, code, date, empty-reason, encounter, identifier, item, notes, patient, source, status, subject, title

Observation PADI-PMOLSTObservation, PADI-PersonalInterventionPreference, PADI-OrganDonationObservation, PADI-AutopsyObservation, PADI-CareExperiencePreference _id, based-on, category, code, code-value-concept, code-value-date, code-value-quantity, code-value-string, combo-code, combo-code-value-concept, combo-code-value-quantity, combo-data-absent-reason, combo-value-concept, combo-value-quantity, component-code, component-code-value-concept, component-code-value-quantity, component-data-absent-reason, component-value-concept, component-value-quantity, data-absent-reason, date, derived-from, device, encounter, focus, has-member, identifier, method, part-of, patient, performer, specimen, status, subject, value-concept, value-date, value-quantity, value-string

Organization _id, active, address, address-city, address-country, address-postalcode, address-state, address-use, endpoint, identifier, name, partof, phonetic, type

Patient us-core-patient _id, active, address, address-city, address-country, address-postalcode, address-state, address-use, birthdate, death-date, deceased, email, family, gender, general-practitioner, given, identifier, language, link, name, organization, phone, phonetic, telecom, race, ethnicity

Provenance PADI-Provenance _id, agent, agent-role, agent-type, entity, location, patient, recorded, signature-type, target, when

RelatedPerson PADI-HealthcareAgent, PADI-Guardian _id, active, address, address-city, address-country, address-postalcode, address-state, address-use, birthdate, email, gender, identifier, name, patient, phone, phonetic, relationship, telecom

Composition

Conformance Expectation: SHALL

Supported Profiles: PADI-Header, PADI-PACPComposition

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Composition resource using:
GET [base]/Composition/[id]

A Server SHOULD be capable of returning a Composition resource using:
GET [base]/Composition/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Composition?_id=[id]

SHOULD attester reference GET [base]/Composition?attester=[attester]

SHOULD author reference GET [base]/Composition?author=[author]

SHALL category token GET [base]/Composition?category=[system]|[code]

MAY confidentiality token GET [base]/Composition?confidentiality=[system]|[code]

MAY context token GET [base]/Composition?context=[system]|[code]

SHALL date date GET [base]/Composition?date=[date]

MAY encounter reference GET [base]/Composition?encounter=[encounter]

MAY entry reference GET [base]/Composition?entry=[entry]

SHALL identifier token GET [base]/Composition?identifier=[system]|[code]

SHALL patient reference GET [base]/Composition?patient=[patient]

SHALL period date GET [base]/Composition?period=[period]

MAY related-id token GET [base]/Composition?related-id=[system]|[code]

MAY related-ref reference GET [base]/Composition?related-ref=[related-ref]

MAY section token GET [base]/Composition?section=[system]|[code]

MAY status token GET [base]/Composition?status=[status]

MAY subject reference GET [base]/Composition?subject=[subject]

MAY title string GET [base]/Composition?title=[title]

SHALL type token GET [base]/Composition?type=[system]|[code]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Composition?_id=[id]`
SHOULD	attester	reference	`GET [base]/Composition?attester=[attester]`
SHOULD	author	reference	`GET [base]/Composition?author=[author]`
SHALL	category	token	`GET [base]/Composition?category=[system]\|[code]`
MAY	confidentiality	token	`GET [base]/Composition?confidentiality=[system]\|[code]`
MAY	context	token	`GET [base]/Composition?context=[system]\|[code]`
SHALL	date	date	`GET [base]/Composition?date=[date]`
MAY	encounter	reference	`GET [base]/Composition?encounter=[encounter]`
MAY	entry	reference	`GET [base]/Composition?entry=[entry]`
SHALL	identifier	token	`GET [base]/Composition?identifier=[system]\|[code]`
SHALL	patient	reference	`GET [base]/Composition?patient=[patient]`
SHALL	period	date	`GET [base]/Composition?period=[period]`
MAY	related-id	token	`GET [base]/Composition?related-id=[system]\|[code]`
MAY	related-ref	reference	`GET [base]/Composition?related-ref=[related-ref]`
MAY	section	token	`GET [base]/Composition?section=[system]\|[code]`
MAY	status	token	`GET [base]/Composition?status=[status]`
MAY	subject	reference	`GET [base]/Composition?subject=[subject]`
MAY	title	string	`GET [base]/Composition?title=[title]`
SHALL	type	token	`GET [base]/Composition?type=[system]\|[code]`

Conformance Expectation: SHALL

Supported Profiles: PADI-HealthcareAgentAuthority, PADI-ConsentForHealthcareAgent

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Consent resource using:
GET [base]/Consent/[id]

A Server SHOULD be capable of returning a Consent resource using:
GET [base]/Consent/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Consent?_id=[id]

SHOULD action token GET [base]/Consent?action=[system]|[code]

SHALL actor reference GET [base]/Consent?actor=[actor]

SHALL category token GET [base]/Consent?category=[system]|[code]

SHALL consentor reference GET [base]/Consent?consentor=[consentor]

MAY data reference GET [base]/Consent?data=[data]

MAY date date GET [base]/Consent?date=[date]

SHOULD identifier token GET [base]/Consent?identifier=[system]|[code]

MAY organization reference GET [base]/Consent?organization=[organization]

SHALL patient reference GET [base]/Consent?patient=[patient]

SHALL period date GET [base]/Consent?period=[period]

SHALL purpose token GET [base]/Consent?purpose=[system]|[code]

SHOULD scope token GET [base]/Consent?scope=[system]|[code]

MAY security-label token GET [base]/Consent?security-label=[system]|[code]

MAY source-reference reference GET [base]/Consent?source-reference=[source-reference]

MAY status token GET [base]/Consent?status=[status]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Consent?_id=[id]`
SHOULD	action	token	`GET [base]/Consent?action=[system]\|[code]`
SHALL	actor	reference	`GET [base]/Consent?actor=[actor]`
SHALL	category	token	`GET [base]/Consent?category=[system]\|[code]`
SHALL	consentor	reference	`GET [base]/Consent?consentor=[consentor]`
MAY	data	reference	`GET [base]/Consent?data=[data]`
MAY	date	date	`GET [base]/Consent?date=[date]`
SHOULD	identifier	token	`GET [base]/Consent?identifier=[system]\|[code]`
MAY	organization	reference	`GET [base]/Consent?organization=[organization]`
SHALL	patient	reference	`GET [base]/Consent?patient=[patient]`
SHALL	period	date	`GET [base]/Consent?period=[period]`
SHALL	purpose	token	`GET [base]/Consent?purpose=[system]\|[code]`
SHOULD	scope	token	`GET [base]/Consent?scope=[system]\|[code]`
MAY	security-label	token	`GET [base]/Consent?security-label=[system]\|[code]`
MAY	source-reference	reference	`GET [base]/Consent?source-reference=[source-reference]`
MAY	status	token	`GET [base]/Consent?status=[status]`

DocumentReference

Conformance Expectation: SHALL

Supported Profiles: PADI-DocumentReference

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a DocumentReference resource using:
GET [base]/DocumentReference/[id]

A Server SHOULD be capable of returning a DocumentReference resource using:
GET [base]/DocumentReference/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/DocumentReference?_id=[id]

MAY authenticator reference GET [base]/DocumentReference?authenticator=[authenticator]

MAY author reference GET [base]/DocumentReference?author=[author]

SHOULD category token GET [base]/DocumentReference?category=[system]|[code]

SHOULD contenttype token GET [base]/DocumentReference?contenttype=[system]|[code]

SHALL custodian reference GET [base]/DocumentReference?custodian=[custodian]

SHALL date date GET [base]/DocumentReference?date=[date]

MAY description string GET [base]/DocumentReference?description=[description]

MAY encounter reference GET [base]/DocumentReference?encounter=[encounter]

MAY event token GET [base]/DocumentReference?event=[system]|[code]

MAY facility token GET [base]/DocumentReference?facility=[system]|[code]

SHOULD format token GET [base]/DocumentReference?format=[system]|[code]

SHALL identifier token GET [base]/DocumentReference?identifier=[system]|[code]

MAY language token GET [base]/DocumentReference?language=[system]|[code]

MAY location uri GET [base]/DocumentReference?location=[uri]

SHALL patient reference GET [base]/DocumentReference?patient=[patient]

SHALL period date GET [base]/DocumentReference?period=[period]

MAY related reference GET [base]/DocumentReference?related=[related]

MAY relatesto reference GET [base]/DocumentReference?relatesto=[relatesto]

MAY relation token GET [base]/DocumentReference?relation=[system]|[code]

MAY relationship composite GET [base]/DocumentReference?relationship=[code]&[value]

MAY security-label token GET [base]/DocumentReference?security-label=[system]|[code]

MAY setting token GET [base]/DocumentReference?setting=[system]|[code]

SHALL status token GET [base]/DocumentReference?status=[status]

MAY subject reference GET [base]/DocumentReference?subject=[subject]

SHALL type token GET [base]/DocumentReference?type=[system]|[code]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/DocumentReference?_id=[id]`
MAY	authenticator	reference	`GET [base]/DocumentReference?authenticator=[authenticator]`
MAY	author	reference	`GET [base]/DocumentReference?author=[author]`
SHOULD	category	token	`GET [base]/DocumentReference?category=[system]\|[code]`
SHOULD	contenttype	token	`GET [base]/DocumentReference?contenttype=[system]\|[code]`
SHALL	custodian	reference	`GET [base]/DocumentReference?custodian=[custodian]`
SHALL	date	date	`GET [base]/DocumentReference?date=[date]`
MAY	description	string	`GET [base]/DocumentReference?description=[description]`
MAY	encounter	reference	`GET [base]/DocumentReference?encounter=[encounter]`
MAY	event	token	`GET [base]/DocumentReference?event=[system]\|[code]`
MAY	facility	token	`GET [base]/DocumentReference?facility=[system]\|[code]`
SHOULD	format	token	`GET [base]/DocumentReference?format=[system]\|[code]`
SHALL	identifier	token	`GET [base]/DocumentReference?identifier=[system]\|[code]`
MAY	language	token	`GET [base]/DocumentReference?language=[system]\|[code]`
MAY	location	uri	`GET [base]/DocumentReference?location=[uri]`
SHALL	patient	reference	`GET [base]/DocumentReference?patient=[patient]`
SHALL	period	date	`GET [base]/DocumentReference?period=[period]`
MAY	related	reference	`GET [base]/DocumentReference?related=[related]`
MAY	relatesto	reference	`GET [base]/DocumentReference?relatesto=[relatesto]`
MAY	relation	token	`GET [base]/DocumentReference?relation=[system]\|[code]`
MAY	relationship	composite	`GET [base]/DocumentReference?relationship=[code]&[value]`
MAY	security-label	token	`GET [base]/DocumentReference?security-label=[system]\|[code]`
MAY	setting	token	`GET [base]/DocumentReference?setting=[system]\|[code]`
SHALL	status	token	`GET [base]/DocumentReference?status=[status]`
MAY	subject	reference	`GET [base]/DocumentReference?subject=[subject]`
SHALL	type	token	`GET [base]/DocumentReference?type=[system]\|[code]`

Goal

Conformance Expectation: SHALL

Supported Profiles: PADI-PersonalHealthGoal

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Goal resource using:
GET [base]/Goal/[id]

A Server SHOULD be capable of returning a Goal resource using:
GET [base]/Goal/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Goal?_id=[id]

MAY achievement-status token GET [base]/Goal?achievement-status=[system]|[code]

SHALL category token GET [base]/Goal?category=[system]|[code]

SHOULD identifier token GET [base]/Goal?identifier=[system]|[code]

SHOULD lifecycle-status token GET [base]/Goal?lifecycle-status=[system]|[code]

SHALL patient reference GET [base]/Goal?patient=[patient]

MAY start-date date GET [base]/Goal?start-date=[start-date]

MAY subject reference GET [base]/Goal?subject=[subject]

MAY target-date date GET [base]/Goal?target-date=[target-date]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Goal?_id=[id]`
MAY	achievement-status	token	`GET [base]/Goal?achievement-status=[system]\|[code]`
SHALL	category	token	`GET [base]/Goal?category=[system]\|[code]`
SHOULD	identifier	token	`GET [base]/Goal?identifier=[system]\|[code]`
SHOULD	lifecycle-status	token	`GET [base]/Goal?lifecycle-status=[system]\|[code]`
SHALL	patient	reference	`GET [base]/Goal?patient=[patient]`
MAY	start-date	date	`GET [base]/Goal?start-date=[start-date]`
MAY	subject	reference	`GET [base]/Goal?subject=[subject]`
MAY	target-date	date	`GET [base]/Goal?target-date=[target-date]`

List

Conformance Expectation: SHALL

Supported Profiles: PADI-PersonalPrioritiesOrganizer

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a List resource using:
GET [base]/List/[id]

A Server SHOULD be capable of returning a List resource using:
GET [base]/List/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/List?_id=[id]

SHALL code token GET [base]/List?code=[system]|[code]

MAY date date GET [base]/List?date=[date]

MAY empty-reason token GET [base]/List?empty-reason=[system]|[code]

MAY encounter reference GET [base]/List?encounter=[encounter]

SHOULD identifier token GET [base]/List?identifier=[system]|[code]

MAY item reference GET [base]/List?item=[item]

MAY notes string GET [base]/List?notes=[notes]

SHALL patient reference GET [base]/List?patient=[patient]

MAY source reference GET [base]/List?source=[source]

MAY status token GET [base]/List?status=[status]

MAY subject reference GET [base]/List?subject=[subject]

MAY title string GET [base]/List?title=[title]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/List?_id=[id]`
SHALL	code	token	`GET [base]/List?code=[system]\|[code]`
MAY	date	date	`GET [base]/List?date=[date]`
MAY	empty-reason	token	`GET [base]/List?empty-reason=[system]\|[code]`
MAY	encounter	reference	`GET [base]/List?encounter=[encounter]`
SHOULD	identifier	token	`GET [base]/List?identifier=[system]\|[code]`
MAY	item	reference	`GET [base]/List?item=[item]`
MAY	notes	string	`GET [base]/List?notes=[notes]`
SHALL	patient	reference	`GET [base]/List?patient=[patient]`
MAY	source	reference	`GET [base]/List?source=[source]`
MAY	status	token	`GET [base]/List?status=[status]`
MAY	subject	reference	`GET [base]/List?subject=[subject]`
MAY	title	string	`GET [base]/List?title=[title]`

Observation

Conformance Expectation: SHALL

Supported Profiles: PADI-PMOLSTObservation, PADI-PersonalInterventionPreference, PADI-OrganDonationObservation, PADI-AutopsyObservation, PADI-CareExperiencePreference

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Observation resource using:
GET [base]/Observation/[id]

A Server SHOULD be capable of returning a Observation resource using:
GET [base]/Observation/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Observation?_id=[id]

MAY based-on reference GET [base]/Observation?based-on=[based-on]

MAY category token GET [base]/Observation?category=[system]|[code]

SHALL code token GET [base]/Observation?code=[system]|[code]

MAY code-value-concept composite GET [base]/Observation?code-value-concept=[code]&[value]

MAY code-value-date composite GET [base]/Observation?code-value-date=[code]&[value]

MAY code-value-quantity composite GET [base]/Observation?code-value-quantity=[code]&[value]

MAY code-value-string composite GET [base]/Observation?code-value-string=[code]&[value]

MAY combo-code token GET [base]/Observation?combo-code=[system]|[code]

MAY combo-code-value-concept composite GET [base]/Observation?combo-code-value-concept=[code]&[value]

MAY combo-code-value-quantity composite GET [base]/Observation?combo-code-value-quantity=[code]&[value]

MAY combo-data-absent-reason token GET [base]/Observation?combo-data-absent-reason=[system]|[code]

MAY combo-value-concept token GET [base]/Observation?combo-value-concept=[system]|[code]

MAY combo-value-quantity quantity GET [base]/Observation?combo-value-quantity=[combo-value-quantity]

MAY component-code token GET [base]/Observation?component-code=[system]|[code]

MAY component-code-value-concept composite GET [base]/Observation?component-code-value-concept=[code]&[value]

MAY component-code-value-quantity composite GET [base]/Observation?component-code-value-quantity=[code]&[value]

MAY component-data-absent-reason token GET [base]/Observation?component-data-absent-reason=[system]|[code]

MAY component-value-concept token GET [base]/Observation?component-value-concept=[system]|[code]

MAY component-value-quantity quantity GET [base]/Observation?component-value-quantity=[component-value-quantity]

MAY data-absent-reason token GET [base]/Observation?data-absent-reason=[system]|[code]

MAY date date GET [base]/Observation?date=[date]

MAY derived-from reference GET [base]/Observation?derived-from=[derived-from]

MAY device reference GET [base]/Observation?device=[device]

MAY encounter reference GET [base]/Observation?encounter=[encounter]

MAY focus reference GET [base]/Observation?focus=[focus]

MAY has-member reference GET [base]/Observation?has-member=[has-member]

SHOULD identifier token GET [base]/Observation?identifier=[system]|[code]

MAY method token GET [base]/Observation?method=[system]|[code]

MAY part-of reference GET [base]/Observation?part-of=[part-of]

SHALL patient reference GET [base]/Observation?patient=[patient]

MAY performer reference GET [base]/Observation?performer=[performer]

MAY specimen reference GET [base]/Observation?specimen=[specimen]

MAY status token GET [base]/Observation?status=[status]

MAY subject reference GET [base]/Observation?subject=[subject]

MAY value-concept token GET [base]/Observation?value-concept=[system]|[code]

MAY value-date date GET [base]/Observation?value-date=[value-date]

MAY value-quantity quantity GET [base]/Observation?value-quantity=[value-quantity]

MAY value-string string GET [base]/Observation?value-string=[value-string]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Observation?_id=[id]`
MAY	based-on	reference	`GET [base]/Observation?based-on=[based-on]`
MAY	category	token	`GET [base]/Observation?category=[system]\|[code]`
SHALL	code	token	`GET [base]/Observation?code=[system]\|[code]`
MAY	code-value-concept	composite	`GET [base]/Observation?code-value-concept=[code]&[value]`
MAY	code-value-date	composite	`GET [base]/Observation?code-value-date=[code]&[value]`
MAY	code-value-quantity	composite	`GET [base]/Observation?code-value-quantity=[code]&[value]`
MAY	code-value-string	composite	`GET [base]/Observation?code-value-string=[code]&[value]`
MAY	combo-code	token	`GET [base]/Observation?combo-code=[system]\|[code]`
MAY	combo-code-value-concept	composite	`GET [base]/Observation?combo-code-value-concept=[code]&[value]`
MAY	combo-code-value-quantity	composite	`GET [base]/Observation?combo-code-value-quantity=[code]&[value]`
MAY	combo-data-absent-reason	token	`GET [base]/Observation?combo-data-absent-reason=[system]\|[code]`
MAY	combo-value-concept	token	`GET [base]/Observation?combo-value-concept=[system]\|[code]`
MAY	combo-value-quantity	quantity	`GET [base]/Observation?combo-value-quantity=[combo-value-quantity]`
MAY	component-code	token	`GET [base]/Observation?component-code=[system]\|[code]`
MAY	component-code-value-concept	composite	`GET [base]/Observation?component-code-value-concept=[code]&[value]`
MAY	component-code-value-quantity	composite	`GET [base]/Observation?component-code-value-quantity=[code]&[value]`
MAY	component-data-absent-reason	token	`GET [base]/Observation?component-data-absent-reason=[system]\|[code]`
MAY	component-value-concept	token	`GET [base]/Observation?component-value-concept=[system]\|[code]`
MAY	component-value-quantity	quantity	`GET [base]/Observation?component-value-quantity=[component-value-quantity]`
MAY	data-absent-reason	token	`GET [base]/Observation?data-absent-reason=[system]\|[code]`
MAY	date	date	`GET [base]/Observation?date=[date]`
MAY	derived-from	reference	`GET [base]/Observation?derived-from=[derived-from]`
MAY	device	reference	`GET [base]/Observation?device=[device]`
MAY	encounter	reference	`GET [base]/Observation?encounter=[encounter]`
MAY	focus	reference	`GET [base]/Observation?focus=[focus]`
MAY	has-member	reference	`GET [base]/Observation?has-member=[has-member]`
SHOULD	identifier	token	`GET [base]/Observation?identifier=[system]\|[code]`
MAY	method	token	`GET [base]/Observation?method=[system]\|[code]`
MAY	part-of	reference	`GET [base]/Observation?part-of=[part-of]`
SHALL	patient	reference	`GET [base]/Observation?patient=[patient]`
MAY	performer	reference	`GET [base]/Observation?performer=[performer]`
MAY	specimen	reference	`GET [base]/Observation?specimen=[specimen]`
MAY	status	token	`GET [base]/Observation?status=[status]`
MAY	subject	reference	`GET [base]/Observation?subject=[subject]`
MAY	value-concept	token	`GET [base]/Observation?value-concept=[system]\|[code]`
MAY	value-date	date	`GET [base]/Observation?value-date=[value-date]`
MAY	value-quantity	quantity	`GET [base]/Observation?value-quantity=[value-quantity]`
MAY	value-string	string	`GET [base]/Observation?value-string=[value-string]`

Organization

Conformance Expectation: SHALL

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Organization resource using:
GET [base]/Organization/[id]

A Server SHOULD be capable of returning a Organization resource using:
GET [base]/Organization/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Organization?_id=[id]

MAY active token GET [base]/Organization?active=[system]|[code]

MAY address string GET [base]/Organization?address=[address]

MAY address-city string GET [base]/Organization?address-city=[address-city]

MAY address-country string GET [base]/Organization?address-country=[address-country]

MAY address-postalcode string GET [base]/Organization?address-postalcode=[address-postalcode]

MAY address-state string GET [base]/Organization?address-state=[address-state]

MAY address-use token GET [base]/Organization?address-use=[system]|[code]

MAY endpoint reference GET [base]/Organization?endpoint=[endpoint]

MAY identifier token GET [base]/Organization?identifier=[system]|[code]

MAY name string GET [base]/Organization?name=[name]

MAY partof reference GET [base]/Organization?partof=[partof]

MAY phonetic string GET [base]/Organization?phonetic=[phonetic]

MAY type token GET [base]/Organization?type=[system]|[code]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Organization?_id=[id]`
MAY	active	token	`GET [base]/Organization?active=[system]\|[code]`
MAY	address	string	`GET [base]/Organization?address=[address]`
MAY	address-city	string	`GET [base]/Organization?address-city=[address-city]`
MAY	address-country	string	`GET [base]/Organization?address-country=[address-country]`
MAY	address-postalcode	string	`GET [base]/Organization?address-postalcode=[address-postalcode]`
MAY	address-state	string	`GET [base]/Organization?address-state=[address-state]`
MAY	address-use	token	`GET [base]/Organization?address-use=[system]\|[code]`
MAY	endpoint	reference	`GET [base]/Organization?endpoint=[endpoint]`
MAY	identifier	token	`GET [base]/Organization?identifier=[system]\|[code]`
MAY	name	string	`GET [base]/Organization?name=[name]`
MAY	partof	reference	`GET [base]/Organization?partof=[partof]`
MAY	phonetic	string	`GET [base]/Organization?phonetic=[phonetic]`
MAY	type	token	`GET [base]/Organization?type=[system]\|[code]`

Patient

Conformance Expectation: SHALL

Supported Profiles: us-core-patient

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Patient resource using:
GET [base]/Patient/[id]

A Server SHOULD be capable of returning a Patient resource using:
GET [base]/Patient/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Patient?_id=[id]

SHOULD active token GET [base]/Patient?active=[system]|[code]

MAY address string GET [base]/Patient?address=[address]

MAY address-city string GET [base]/Patient?address-city=[address-city]

MAY address-country string GET [base]/Patient?address-country=[address-country]

MAY address-postalcode string GET [base]/Patient?address-postalcode=[address-postalcode]

MAY address-state string GET [base]/Patient?address-state=[address-state]

MAY address-use token GET [base]/Patient?address-use=[system]|[code]

SHALL birthdate date GET [base]/Patient?birthdate=[birthdate]

MAY death-date date GET [base]/Patient?death-date=[death-date]

MAY deceased token GET [base]/Patient?deceased=[system]|[code]

SHOULD email token GET [base]/Patient?email=[system]|[code]

SHALL family string GET [base]/Patient?family=[family]

SHALL gender token GET [base]/Patient?gender=[system]|[code]

MAY general-practitioner reference GET [base]/Patient?general-practitioner=[general-practitioner]

SHALL given string GET [base]/Patient?given=[given]

SHALL identifier token GET [base]/Patient?identifier=[system]|[code]

MAY language token GET [base]/Patient?language=[system]|[code]

MAY link reference GET [base]/Patient?link=[link]

SHALL name string GET [base]/Patient?name=[name]

MAY organization reference GET [base]/Patient?organization=[organization]

SHOULD phone token GET [base]/Patient?phone=[system]|[code]

MAY phonetic string GET [base]/Patient?phonetic=[phonetic]

SHOULD telecom token GET [base]/Patient?telecom=[system]|[code]

MAY race token GET [base]/Patient?race=[system]|[code]

MAY ethnicity token GET [base]/Patient?ethnicity=[system]|[code]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Patient?_id=[id]`
SHOULD	active	token	`GET [base]/Patient?active=[system]\|[code]`
MAY	address	string	`GET [base]/Patient?address=[address]`
MAY	address-city	string	`GET [base]/Patient?address-city=[address-city]`
MAY	address-country	string	`GET [base]/Patient?address-country=[address-country]`
MAY	address-postalcode	string	`GET [base]/Patient?address-postalcode=[address-postalcode]`
MAY	address-state	string	`GET [base]/Patient?address-state=[address-state]`
MAY	address-use	token	`GET [base]/Patient?address-use=[system]\|[code]`
SHALL	birthdate	date	`GET [base]/Patient?birthdate=[birthdate]`
MAY	death-date	date	`GET [base]/Patient?death-date=[death-date]`
MAY	deceased	token	`GET [base]/Patient?deceased=[system]\|[code]`
SHOULD	email	token	`GET [base]/Patient?email=[system]\|[code]`
SHALL	family	string	`GET [base]/Patient?family=[family]`
SHALL	gender	token	`GET [base]/Patient?gender=[system]\|[code]`
MAY	general-practitioner	reference	`GET [base]/Patient?general-practitioner=[general-practitioner]`
SHALL	given	string	`GET [base]/Patient?given=[given]`
SHALL	identifier	token	`GET [base]/Patient?identifier=[system]\|[code]`
MAY	language	token	`GET [base]/Patient?language=[system]\|[code]`
MAY	link	reference	`GET [base]/Patient?link=[link]`
SHALL	name	string	`GET [base]/Patient?name=[name]`
MAY	organization	reference	`GET [base]/Patient?organization=[organization]`
SHOULD	phone	token	`GET [base]/Patient?phone=[system]\|[code]`
MAY	phonetic	string	`GET [base]/Patient?phonetic=[phonetic]`
SHOULD	telecom	token	`GET [base]/Patient?telecom=[system]\|[code]`
MAY	race	token	`GET [base]/Patient?race=[system]\|[code]`
MAY	ethnicity	token	`GET [base]/Patient?ethnicity=[system]\|[code]`

Provenance

Conformance Expectation: SHALL

Supported Profiles: PADI-Provenance

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Provenance resource using:
GET [base]/Provenance/[id]

A Server SHOULD be capable of returning a Provenance resource using:
GET [base]/Provenance/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Provenance?_id=[id]

SHOULD agent reference GET [base]/Provenance?agent=[agent]

MAY agent-role token GET [base]/Provenance?agent-role=[system]|[code]

MAY agent-type token GET [base]/Provenance?agent-type=[system]|[code]

MAY entity reference GET [base]/Provenance?entity=[entity]

MAY location reference GET [base]/Provenance?location=[location]

MAY patient reference GET [base]/Provenance?patient=[patient]

MAY recorded date GET [base]/Provenance?recorded=[recorded]

MAY signature-type token GET [base]/Provenance?signature-type=[system]|[code]

SHOULD target reference GET [base]/Provenance?target=[target]

MAY when date GET [base]/Provenance?when=[when]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Provenance?_id=[id]`
SHOULD	agent	reference	`GET [base]/Provenance?agent=[agent]`
MAY	agent-role	token	`GET [base]/Provenance?agent-role=[system]\|[code]`
MAY	agent-type	token	`GET [base]/Provenance?agent-type=[system]\|[code]`
MAY	entity	reference	`GET [base]/Provenance?entity=[entity]`
MAY	location	reference	`GET [base]/Provenance?location=[location]`
MAY	patient	reference	`GET [base]/Provenance?patient=[patient]`
MAY	recorded	date	`GET [base]/Provenance?recorded=[recorded]`
MAY	signature-type	token	`GET [base]/Provenance?signature-type=[system]\|[code]`
SHOULD	target	reference	`GET [base]/Provenance?target=[target]`
MAY	when	date	`GET [base]/Provenance?when=[when]`

RelatedPerson

Conformance Expectation: SHALL

Supported Profiles: PADI-HealthcareAgent, PADI-Guardian

Reference Policy: resolves

Profile Interaction Summary:

SHALL support create, search-type, read, update.
SHOULD support vread, history-instance.

Fetch and Search Criteria:

A Server SHALL be capable of returning a RelatedPerson resource using:
GET [base]/RelatedPerson/[id]

A Server SHOULD be capable of returning a RelatedPerson resource using:
GET [base]/RelatedPerson/[id]/_history/vid

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/RelatedPerson?_id=[id]

MAY active token GET [base]/RelatedPerson?active=[system]|[code]

MAY address string GET [base]/RelatedPerson?address=[address]

MAY address-city string GET [base]/RelatedPerson?address-city=[address-city]

MAY address-country string GET [base]/RelatedPerson?address-country=[address-country]

MAY address-postalcode string GET [base]/RelatedPerson?address-postalcode=[address-postalcode]

MAY address-state string GET [base]/RelatedPerson?address-state=[address-state]

MAY address-use token GET [base]/RelatedPerson?address-use=[system]|[code]

SHOULD birthdate date GET [base]/RelatedPerson?birthdate=[birthdate]

SHOULD email token GET [base]/RelatedPerson?email=[system]|[code]

SHOULD gender token GET [base]/RelatedPerson?gender=[system]|[code]

SHOULD identifier token GET [base]/RelatedPerson?identifier=[system]|[code]

SHOULD name string GET [base]/RelatedPerson?name=[name]

SHALL patient reference GET [base]/RelatedPerson?patient=[patient]

SHOULD phone token GET [base]/RelatedPerson?phone=[system]|[code]

MAY phonetic string GET [base]/RelatedPerson?phonetic=[phonetic]

SHALL relationship token GET [base]/RelatedPerson?relationship=[system]|[code]

SHOULD telecom token GET [base]/RelatedPerson?telecom=[system]|[code]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/RelatedPerson?_id=[id]`
MAY	active	token	`GET [base]/RelatedPerson?active=[system]\|[code]`
MAY	address	string	`GET [base]/RelatedPerson?address=[address]`
MAY	address-city	string	`GET [base]/RelatedPerson?address-city=[address-city]`
MAY	address-country	string	`GET [base]/RelatedPerson?address-country=[address-country]`
MAY	address-postalcode	string	`GET [base]/RelatedPerson?address-postalcode=[address-postalcode]`
MAY	address-state	string	`GET [base]/RelatedPerson?address-state=[address-state]`
MAY	address-use	token	`GET [base]/RelatedPerson?address-use=[system]\|[code]`
SHOULD	birthdate	date	`GET [base]/RelatedPerson?birthdate=[birthdate]`
SHOULD	email	token	`GET [base]/RelatedPerson?email=[system]\|[code]`
SHOULD	gender	token	`GET [base]/RelatedPerson?gender=[system]\|[code]`
SHOULD	identifier	token	`GET [base]/RelatedPerson?identifier=[system]\|[code]`
SHOULD	name	string	`GET [base]/RelatedPerson?name=[name]`
SHALL	patient	reference	`GET [base]/RelatedPerson?patient=[patient]`
SHOULD	phone	token	`GET [base]/RelatedPerson?phone=[system]\|[code]`
MAY	phonetic	string	`GET [base]/RelatedPerson?phonetic=[phonetic]`
SHALL	relationship	token	`GET [base]/RelatedPerson?relationship=[system]\|[code]`
SHOULD	telecom	token	`GET [base]/RelatedPerson?telecom=[system]\|[code]`