International Patient Access
0.1.0 - draft

International Patient Access, published by HL7. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/grahamegrieve/ipa-candidate/ and changes regularly. See the Directory of published versions

StructureDefinition: IPAPractitioner

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

The official URL for this profile is:

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

This profile describes how applications fetch Practitioner resources that provide information about other individuals that are involved in the care of the patient.

Example Usage Scenarios:

A patient’s record is full of records of events or planned actions where the actors of various kinds are care practitioners of various kinds. Note that these include any person employed by a healthcare provider, including clerical staff, orderlies, etc as well as the more obvious practitioners such as doctors and nurses. All these may be represented as a PractitionerRole resource.

Note that the Patient Access API provides access to both Practitioner and PractitionerRole resources. The difference in underlying record keeping that leads to this choice is not of interest to clients that access patient records, but they can expect to encounter both types of resource.

All servers SHALL provide an API to access Practitioner Resources as described here. Note that servers are allowed to provide some practitioner records as contained resources, but SHOULD avoid doing so where ever possible.

Clients access practitioner resources using this call:

GET [url]/Practitioner/[id]

where id is found in some other resource that refers to a Practitioner. The result of this search is a Practitioner resource, or an error there is no resource the client can access for that id.

The Practitioner SHALL have:

  • an active flag
  • a name

Note that in some cases, the actual name of the practitioner is not made available. In such cases, the server SHALL provider some human-useful text in HumanName.text that the client can use.

Servers may choose to provide additional information, or may be required to do so by national or other additional profiles on practitioner that apply in the servers context.

Servers are not required to support search functionality on Practitioner, but may do so. If they do, the search SHALL be limited to Practitioner resources that relate to the patient in scope. Typical search parameters a Server could choose to support would be name and active

Formal Views of Profile Content

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

This structure is derived from Practitioner

Summary

Mandatory: 2 elements
Must-Support: 2 elements

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierAn identifier for the person as this agent
... active SΣI1..1booleanWhether this practitioner's record is in active use
... name SΣI1..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
.... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period I0..1PeriodPeriod during which the qualification is valid
.... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format

This structure is derived from Practitioner

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierAn identifier for the person as this agent
... active SΣI1..1booleanWhether this practitioner's record is in active use
... name SΣI1..*HumanNameThe name(s) associated with the practitioner
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
.... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period I0..1PeriodPeriod during which the qualification is valid
.... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codeexamplev2.0360.2.7
Practitioner.communicationpreferredCommonLanguages
Max Binding: AllLanguages

Constraints

Constraints

IdPathDetailsRequirements