R6 Checklist for Patient

Artifact Patient (Patient)

Urgent Item Checklist

Confirm workgroup disposition vote has been recorded and sent to FMG!
Element: Patient.contact.role flagged as trial-use
Element: Patient.contact.additionalName flagged as trial-use
Element: Patient.contact.additionalAddress flagged as trial-use
Search Parameter: example-extension (ExampleSearchParameterOnAnExtension) flagged as experimental

All Analysis Information

The following content was generated to assist in the review of this artifact for R6 compliance.

Information Page

General Information:

Page File Name	`patient-introduction.xml`
Responsible Workgroup	`pa`
Maturity Label	`Active`
Maturity Level	`5`
Standards Status	`normative`
Management Comments
Workgroup Comments
Exists In `publish.ini`	`No`
Exists In Source Directory	`Yes`
'`deprecated`' Literal Count	`0`
Zulip Link Count	`0`
Confluence Link Count	`0`

Conformance Language Summary

'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.

Literal	Conformant	Non-Conformant
SHALL	0	0
SHALL NOT	0	0
SHOULD	0	0
SHOULD NOT	0	0
MAY	0	9
MAY NOT	0	0

Possibly Removed FHIR Artifact Literals Found on Page

Word	Artifact Class

Unknown Words Found on Page

Word	Known Typo

Images with Issues

Source	Missing Alt Text	Not In Figure Tag

Possible Incomplete Markers Found on Page

Reader Review Notes Found on Page

Notes Page

General Information:

Page File Name	`patient-notes.xml`
Responsible Workgroup	`pa`
Maturity Label	`Active`
Maturity Level	`5`
Standards Status	`normative`
Management Comments
Workgroup Comments
Exists In `publish.ini`	`No`
Exists In Source Directory	`Yes`
'`deprecated`' Literal Count	`0`
Zulip Link Count	`0`
Confluence Link Count	`0`

Conformance Language Summary

'Conformant' conformance language appears in all-upper case. 'Non-conformant' covers all other cases appearing in the content.

Literal	Conformant	Non-Conformant
SHALL	1	0
SHALL NOT	0	0
SHOULD	0	16
SHOULD NOT	0	3
MAY	0	19
MAY NOT	0	0

Possibly Removed FHIR Artifact Literals Found on Page

Word	Artifact Class
`CarePlan.participant,`	Element
`patient-animal`	Element

Unknown Words Found on Page

Word	Known Typo
`(RSG)`	No
`(SPCU)`	No
`MPIs`	No
`genderIdentity`	No
`genderStatus`	No
`multipleBirth`	No
`partOf`	No
`sexParameterForClinicalUse`	No

Images with Issues

Source	Missing Alt Text	Not In Figure Tag

Possible Incomplete Markers Found on Page

Reader Review Notes Found on Page

Element Review

Path	Is Required	Not Array	Trial Use	Has fixed[x]	Has pattern[x]	Required Binding	External Required Binding	Check `meaningWhenMissing`	Is Modifier
`Patient`		X
`Patient.identifier`		X
`Patient.active`									X
`Patient.name`		X
`Patient.telecom`		X
`Patient.gender`						optional - Has 'other' and 'unknown'		X
`Patient.birthDate`
`Patient.deceased[x]`								X	X
`Patient.address`		X
`Patient.maritalStatus`
`Patient.multipleBirth[x]`								X
`Patient.photo`		X
`Patient.contact`		X
`Patient.contact.relationship`		X
`Patient.contact.role`		X	X
`Patient.contact.name`
`Patient.contact.additionalName`		X	X
`Patient.contact.telecom`		X
`Patient.contact.address`
`Patient.contact.additionalAddress`		X	X
`Patient.contact.gender`						optional - Has 'other' and 'unknown'		X
`Patient.contact.organization`
`Patient.contact.period`
`Patient.communication`		X
`Patient.communication.language`	X					NO 'other' or 'unknown'
`Patient.communication.preferred`								X
`Patient.generalPractitioner`		X
`Patient.managingOrganization`
`Patient.link`		X							X
`Patient.link.other`	X
`Patient.link.type`	X					NO 'other' or 'unknown'

Operations

Id	Name	Publication Status	FMM	Standards Status	IsExperimental	Workgroup	Description
`Patient-everything`	`Everything`	Draft	5	trial-use	False	pa	This operation is used to return all the information related to one or more patients described in the resource or context on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource(s) itself is returned, along with any other resources that the server has that are related to the patient(s), and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc. The intended use for this operation is to provide a patient with access to their entire record (e.g. "Blue Button"), or for provider or other user to perform a bulk data download. The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient(s), and any resource referenced from those, including binaries and attachments. The server SHOULD resolve version-specific references by returning the explicitly named version. Implementation guides may make additional rules about how much information that is returned.
`Patient-match`	`Match`	Draft	5	trial-use	False	pa	A Master Patient Index ([MPI](http://en.wikipedia.org/wiki/Enterprise_master_patient_index) ) is a service used to manage patient identification in a context where multiple patient databases exist. Healthcare applications and middleware use the MPI to match patients between the databases, and to store new patient details as they are encountered. MPIs are highly specialized applications, often tailored extensively to the institution's particular mix of patients. MPIs can also be run on a regional and national basis. To ask an MPI to match a patient, clients use the "$match" operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set. Note that different MPI matching algorithms have different required inputs. Consult with the vendor implementing the $match operation as to its specific behaviors. The generic $match operation does not specify any particular algorithm, nor a minimum set of information that must be provided when asking for an MPI match operation to be performed, but many implementations will have a set of minimum information, which may be declared in their definition of the $match operation by specifying a profile on the resource parameter, indicating which properties are required in the search. The patient resource submitted to the operation does not have to be complete, nor does it need to pass validation (i.e. mandatory fields don't need to be populated), but it does have to be a valid instance, as it is used as the reference data to match against. Implementers of the $match algorithm should consider the relevance of returning inactive patients, particularly ones associated with patient merges. E.g. If an inactive patient is "matched" and its merged target resource will be included, then the inactive one may be excluded, however if a patient was just marked as inactive for other reasons, it could be included in the results. (any specific MPI algorithm may or might not behave as in these examples)
`Patient-merge`	`Merge`	Draft	0	trial-use	False	pa	The merge operation is used to request two patient resources be merged. One of the two patients is identified as the source and one as the target. The data from the source patient will be merged with the data of the target patient. The source Patient resource will be updated to add a new Patient.link reference to the target Patient resource with a link-type of replaced-by. The source Patient will also be updated to have a status of inactive, unless the source Patient resource was deleted. The target Patient resource will be updated to add a new Patient.link reference to the source Patient resource with a link-type of replaces unless the source Patient resource is deleted. The target Patient resource must be included in the result-patient parameter if used.
`Patient-purge`	`Purge`	Draft	2	trial-use	False	pa	This operation is used to request the removal of all current and historical versions for all resources in a patient compartment. The result will be an OperationOutcome with results and/or details about execution. Following are some common `issue-type` values: - `success` the request has been completed to the server's satisfaction - the patient and associated resources are no longer accessible - `incomplete` the request is partially complete, but additional processing will continue (e.g., the server is continuing to clean out resources) When supported, it is recommended (though not required) to support an [Asynchronous Request Pattern](http://hl7.org/fhir/R6/async.html). Note that the deletion of resources typically involves many policy decisions. Implementers are expected to use this operation in conjunction with their policies for such a request - e.g., soft vs. hard delete, audibility/traceability, evaluation of referential integrity, etc.
`example-query-high-risk`	`ExampleOfHighRiskPatientQuery`	Draft				fhir	Example Named Query of Patients based on risk assessments

Search Parameters

Id	Name	Publication Status	FMM	Standards Status	IsExperimental	WorkGroup	Search Type	Description
`Patient-active`	`active`	Active		normative	False	pa	token	Whether the patient record is active
`Patient-death-date`	`death-date`	Active		normative	False	pa	date	The date of death has been provided and satisfies this search value
`Patient-deceased`	`deceased`	Active		normative	False	pa	token	This patient has been marked as deceased, or has a death date entered
`Patient-general-practitioner`	`general-practitioner`	Active		normative	False	pa	reference	Patient's nominated general practitioner, not the organization that manages the record
`Patient-identifier`	`identifier`	Active		normative	False	pa	token	A patient identifier
`Patient-language`	`language`	Active		normative	False	pa	token	Language code (irrespective of use value)
`Patient-link`	`link`	Active		normative	False	pa	reference	All patients/related persons linked to the given patient
`Patient-name`	`name`	Active		normative	False	pa	string	A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text
`Patient-organization`	`organization`	Active		normative	False	pa	reference	The organization that is the custodian of the patient record
`example-extension`	`ExampleSearchParameterOnAnExtension`	Draft			True	fhir	reference	Search by url for a participation agreement, which is stored as an extension referencing a DocumentReference
`individual-address`	`address`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text * [Person](http://hl7.org/fhir/R6/person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
`individual-address-city`	`address-city`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A city specified in an address * [Person](http://hl7.org/fhir/R6/person.html): A city specified in an address * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A city specified in an address * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A city specified in an address
`individual-address-country`	`address-country`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A country specified in an address * [Person](http://hl7.org/fhir/R6/person.html): A country specified in an address * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A country specified in an address * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A country specified in an address
`individual-address-postalcode`	`address-postalcode`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A postalCode specified in an address * [Person](http://hl7.org/fhir/R6/person.html): A postal code specified in an address * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A postalCode specified in an address * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A postal code specified in an address
`individual-address-state`	`address-state`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A state specified in an address * [Person](http://hl7.org/fhir/R6/person.html): A state specified in an address * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A state specified in an address * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A state specified in an address
`individual-address-use`	`address-use`	Active		normative	False	pa	token	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A use code specified in an address * [Person](http://hl7.org/fhir/R6/person.html): A use code specified in an address * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A use code specified in an address * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A use code specified in an address
`individual-birthdate`	`birthdate`	Active		normative	False	pa	date	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): The patient's date of birth * [Person](http://hl7.org/fhir/R6/person.html): The person's date of birth * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): The Related Person's date of birth
`individual-email`	`email`	Active		normative	False	pa	token	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A value in an email contact * [Person](http://hl7.org/fhir/R6/person.html): A value in an email contact * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A value in an email contact * [PractitionerRole](http://hl7.org/fhir/R6/practitionerrole.html): A value in an email contact * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A value in an email contact
`individual-family`	`family`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A portion of the family name of the patient * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A portion of the family name
`individual-gender`	`gender`	Active		normative	False	pa	token	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): Gender of the patient * [Person](http://hl7.org/fhir/R6/person.html): The gender of the person * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): Gender of the practitioner * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): Gender of the related person
`individual-given`	`given`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A portion of the given name of the patient * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A portion of the given name
`individual-phone`	`phone`	Active		normative	False	pa	token	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A value in a phone contact * [Person](http://hl7.org/fhir/R6/person.html): A value in a phone contact * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A value in a phone contact * [PractitionerRole](http://hl7.org/fhir/R6/practitionerrole.html): A value in a phone contact * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A value in a phone contact
`individual-phonetic`	`phonetic`	Active		normative	False	pa	string	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): A portion of either family or given name using some kind of phonetic matching algorithm * [Person](http://hl7.org/fhir/R6/person.html): A portion of name using some kind of phonetic matching algorithm * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): A portion of name using some kind of phonetic matching algorithm
`individual-telecom`	`telecom`	Active		normative	False	pa	token	Multiple Resources: * [Patient](http://hl7.org/fhir/R6/patient.html): The value in any kind of telecom details of the patient * [Person](http://hl7.org/fhir/R6/person.html): The value in any kind of contact * [Practitioner](http://hl7.org/fhir/R6/practitioner.html): The value in any kind of contact * [PractitionerRole](http://hl7.org/fhir/R6/practitionerrole.html): The value in any kind of contact * [RelatedPerson](http://hl7.org/fhir/R6/relatedperson.html): The value in any kind of contact