IE (Ireland) Core Implementation Guide
1.0.0-ballot - Ballot Ireland flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: IE Core Practitioner Profile

Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-practitioner Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: IECorePractitionerProfile
Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.47

Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License

The IE Core Practitioner Profile inherits from the FHIR Practitioner resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Practitioner resource to record, search, and fetch basic demographics and administrative information about an individual practitioner. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for a practitioner by name or NPI
  • Reference from other Resources

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Practitioner Must Have:

  1. An identifier that Must Support an NPI if available.
  2. A name

Each PractitionerRole Must Support:

  1. Contact information*
  2. An address*

* see guidance below

Profile Specific Implementation Guidance:

  • *The Practitioner and PractitionerRole directly and indirectly communicate the address(es) and contact information of the practitioner. Servers that support only the IE Core Practitioner Profile and do not support the IE Core PractitionerRole Profile SHALL provide implementation-specific guidance on how to access a provider's location and contact information using only the Practitioner resource.
    • Although Practitioner.address is marked as Must Support, the server system is not required to support it if they support the IE Core PractitionerRole Profile, but SHALL support it if they do not support the IE Core PractitionerRole Profile. The client application SHALL support both.
  • It is important to balance the privacy of healthcare workers with the patient's right to access information. Only professional/work contact information about the practitioner SHOULD be available to the patient (such as a work address or office telephone number).
  • This profile may be referenced by different capability statements, such as the Conformance requirements for the IE Core Server or a provider directory capability statement.
  • * Systems SHOULD follow the Project IE@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for Practitioner.address.line and  Practitioner.address.city.

Usage:

Formal Views of Profile Content

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

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... Slices for identifier S 0..* IECoreIrishMedicalCouncil An identifier for the person as this agent
Slice: Unordered, Open by pattern:system
.... identifier:IMC SC 0..1 Identifier Irish Medical Council (IMC)
... name S 1..* HumanName The name(s) associated with the practitioner
.... family S 1..1 string Family name (often called 'Surname')
... telecom S 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system S 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
... address S 0..* Address Address(es) of the practitioner
.... line S 0..* string Street name, number, direction & P.O. Box etc.
Example General: 51 Bracken Rd
.... city S 0..1 string Name of city, town etc.
Example General: Sandyford
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode S 0..1 string IE Eircodes
Example General: D18 CV48
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* IECoreIrishMedicalCouncil An identifier for the person as this agent
Slice: Unordered, Open by pattern:system
.... identifier:IMC SΣC 0..1 Identifier Irish Medical Council (IMC)
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ 1..1 string Family name (often called 'Surname')
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SΣ 0..* Address Address(es) of the practitioner
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: 51 Bracken Rd
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΣ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for identifier SΣ 0..* IECoreIrishMedicalCouncil An identifier for the person as this agent
Slice: Unordered, Open by pattern:system
.... identifier:IMC SΣC 0..1 Identifier Irish Medical Council (IMC)
... active Σ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: 51 Bracken Rd
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΣ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... 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
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from Practitioner

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.identifier

Maturity: 3

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... Slices for identifier S 0..* IECoreIrishMedicalCouncil An identifier for the person as this agent
Slice: Unordered, Open by pattern:system
.... identifier:IMC SC 0..1 Identifier Irish Medical Council (IMC)
... name S 1..* HumanName The name(s) associated with the practitioner
.... family S 1..1 string Family name (often called 'Surname')
... telecom S 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system S 0..1 code phone | fax | email | pager | url | sms | other
.... value S 0..1 string The actual contact point details
... address S 0..* Address Address(es) of the practitioner
.... line S 0..* string Street name, number, direction & P.O. Box etc.
Example General: 51 Bracken Rd
.... city S 0..1 string Name of city, town etc.
Example General: Sandyford
.... state S 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode S 0..1 string IE Eircodes
Example General: D18 CV48
.... country S 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* IECoreIrishMedicalCouncil An identifier for the person as this agent
Slice: Unordered, Open by pattern:system
.... identifier:IMC SΣC 0..1 Identifier Irish Medical Council (IMC)
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ 1..1 string Family name (often called 'Surname')
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SΣ 0..* Address Address(es) of the practitioner
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: 51 Bracken Rd
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΣ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id 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): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... Slices for identifier SΣ 0..* IECoreIrishMedicalCouncil An identifier for the person as this agent
Slice: Unordered, Open by pattern:system
.... identifier:IMC SΣC 0..1 Identifier Irish Medical Council (IMC)
... active Σ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Example General: 51 Bracken Rd
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: Sandyford
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: Ireland Counties (extensible): County


Example General: Dublin
.... postalCode SΣ 0..1 string IE Eircodes
Example General: 9132
Example General: D18 CV48
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... 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
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.address.stateextensibleIECoreCounties (a valid code from Irish Counties)
http://iehr.ai/fhir/ie/core/ValueSet/ie-core-counties
from this IG
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from Practitioner

Summary

Mandatory: 2 elements
Must-Support: 13 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.identifier

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

  • See the Scopes Format section for a description of the SMART scopes syntax.
  • See the Search Syntax section for a description of the IE Core search syntax.
  • See the General Requirements section for additional rules and expectations when a server requires status parameters.
  • See the General Guidance section for additional guidance on searching for multiple patients.

IE Core Scopes

Servers providing access to practitioner data SHALL support these IE Core SMART Scopes:

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching for a practitioner by a string match of any part of name using the name search parameter:

    GET [base]/Practitioner?name=[string]

    Example:

    1. GET [base]/Practitioner?name=Smith

    Implementation Notes: Fetches a bundle of all Practitioner resources matching the name (how to search by string)

  2. SHALL support searching a practitioner by an identifier such as an NPI using the identifier search parameter:

    GET [base]/Practitioner?identifier={system|}[code]

    Example:

    1. GET [base]/Practitioner?dentifier=http://iehr.ai/fhir/sid/ie/crn|97860456

    Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support both read Practitioner by id AND Practitioner search using the _id search parameter:

    GET [base]/Practitioner/[id] or GET [base]/Practitioner?_id=[id]

    Example:

    1. GET [base]/Practitioner/practitioner-1
    2. GET [base]/Practitioner?_id=practitioner-1

    Implementation Notes: (how to search by the logical id of the resource)