HL7.FHIR.US.BSER\BSeR_Practitioner

BSeR: Bidirectional Services_eReferral

This page is part of the Bidirectional Services eReferrals (BSeR) (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BSeR_Practitioner

An individual who are engaged in the health care process or health care-related services as part of their formal responsibilities.

The official URL for this profile is:

http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Practitioner

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 5 elements (2 nested mandatory elements)

This structure is derived from USCorePractitionerProfile

Name	Card.	Type
Practitioner	0..*	USCorePractitionerProfile
identifier	1..*	Identifier
value	1..1	string
name	1..1	HumanName
family	1..1	string
given	1..*	string
prefix	0..1	string
suffix	0..1	string
telecom	0..*	ContactPoint
system	1..1	code
value	1..1	string
use	0..1	code
address	0..1	Address
use	0..1	code
city	0..1	string
state	0..1	string
postalCode	0..1	string
country	0..1	string
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Practitioner	I	0..*	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	SΣI	1..*	(Slice Definition)	An identifier for the person as this agent Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	ΣI	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	SΣI	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣI	1..1	string	The value that is unique Example General: 123456
period	ΣI	0..1	Period	Time period when id is/was valid for use
assigner	ΣI	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:NPI	SΣI	0..1	Identifier	An identifier for the person as this agent Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	ΣI	0..1	boolean	Whether this practitioner's record is in active use
name	SΣI	1..1	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	ΣI	0..1	string	Text representation of the full name
family	SΣI	1..1	string	Family name (often called 'Surname')
given	ΣI	1..*	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	ΣI	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	ΣI	0..1	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	ΣI	0..1	Period	Time period when name was/is in use
telecom	ΣI	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	ΣI	1..1	string	The actual contact point details
use	?!ΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	ΣI	0..1	Address	Address(es) of the practitioner that are not role specific (typically home address)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	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
city	ΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	0..1	string	Postal code for area Example General: 9132
country	ΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
gender	ΣI	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	ΣI	0..1	date	The date on which the practitioner was born
photo	I	0..*	Attachment	Image of the person
qualification	I	0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	I	0..*	Identifier	An identifier for this qualification for the practitioner
code	I	1..1	CodeableConcept	Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example)
period	I	0..1	Period	Period during which the qualification is valid
issuer	I	0..1	Reference(Organization)	Organization that regulates and issues the qualification
communication	I	0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred) Max Binding: AllLanguages
Documentation for this format

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 5 elements (2 nested mandatory elements)

Differential View

This structure is derived from USCorePractitionerProfile

Name	Card.	Type
Practitioner	0..*	USCorePractitionerProfile
identifier	1..*	Identifier
value	1..1	string
name	1..1	HumanName
family	1..1	string
given	1..*	string
prefix	0..1	string
suffix	0..1	string
telecom	0..*	ContactPoint
system	1..1	code
value	1..1	string
use	0..1	code
address	0..1	Address
use	0..1	code
city	0..1	string
state	0..1	string
postalCode	0..1	string
country	0..1	string
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Practitioner	I	0..*	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	SΣI	1..*	(Slice Definition)	An identifier for the person as this agent Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required)
type	ΣI	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
system	SΣI	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣI	1..1	string	The value that is unique Example General: 123456
period	ΣI	0..1	Period	Time period when id is/was valid for use
assigner	ΣI	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:NPI	SΣI	0..1	Identifier	An identifier for the person as this agent Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
use		0..1	code	usual \| official \| temp \| secondary \| old (If known)
type		0..1	CodeableConcept	Description of identifier
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
value		0..1	string	The value that is unique
period		0..1	Period	Time period when id is/was valid for use
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
active	ΣI	0..1	boolean	Whether this practitioner's record is in active use
name	SΣI	1..1	HumanName	The name(s) associated with the practitioner
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	ΣI	0..1	string	Text representation of the full name
family	SΣI	1..1	string	Family name (often called 'Surname')
given	ΣI	1..*	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	ΣI	0..1	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	ΣI	0..1	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	ΣI	0..1	Period	Time period when name was/is in use
telecom	ΣI	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	ΣI	1..1	string	The actual contact point details
use	?!ΣI	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	ΣI	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣI	0..1	Period	Time period when the contact point was/is in use
address	ΣI	0..1	Address	Address(es) of the practitioner that are not role specific (typically home address)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!ΣI	0..1	code	home \| work \| temp \| old \| billing - purpose of this address Binding: AddressUse (required) Example General: home
type	ΣI	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	ΣI	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	ΣI	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
city	ΣI	0..1	string	Name of city, town etc. Example General: Erewhon
district	ΣI	0..1	string	District name (aka county) Example General: Madison
state	ΣI	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	ΣI	0..1	string	Postal code for area Example General: 9132
country	ΣI	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	ΣI	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
gender	ΣI	0..1	code	male \| female \| other \| unknown Binding: AdministrativeGender (required)
birthDate	ΣI	0..1	date	The date on which the practitioner was born
photo	I	0..*	Attachment	Image of the person
qualification	I	0..*	BackboneElement	Certification, licenses, or training pertaining to the provision of care
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	I	0..*	Identifier	An identifier for this qualification for the practitioner
code	I	1..1	CodeableConcept	Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example)
period	I	0..1	Period	Period during which the qualification is valid
issuer	I	0..1	Reference(Organization)	Organization that regulates and issues the qualification
communication	I	0..*	CodeableConcept	A language the practitioner can use in patient communication Binding: CommonLanguages (preferred) Max Binding: AllLanguages
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Practitioner.language	preferred	CommonLanguages Max Binding: AllLanguages
Practitioner.identifier.use	required	IdentifierUse
Practitioner.identifier.type	extensible	Identifier Type Codes
Practitioner.name.use	required	NameUse
Practitioner.telecom.system	required	ContactPointSystem
Practitioner.telecom.use	required	ContactPointUse
Practitioner.address.use	required	AddressUse
Practitioner.address.type	required	AddressType
Practitioner.gender	required	AdministrativeGender
Practitioner.qualification.code	example	v2.0360.2.7
Practitioner.communication	preferred	CommonLanguages Max Binding: AllLanguages

Constraints

Id	Path	Details	Requirements
dom-2	Practitioner	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Practitioner	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	Practitioner	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	Practitioner	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Practitioner	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Practitioner.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.identifier:NPI	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.name.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.name.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name.family	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name.given	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name.prefix	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name.suffix	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.name.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.telecom.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.telecom.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.telecom.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.telecom.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.telecom.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.telecom.rank	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.telecom.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.address.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.birthDate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.photo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.qualification	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.qualification.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.qualification.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.qualification.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Practitioner.qualification.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Practitioner.qualification.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.qualification.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.qualification.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.qualification.issuer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Practitioner.communication	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2019+ HL7 International - Public Health Work Group. Package hl7.fhir.us.bser#1.0.0 based on FHIR 4.0.1. Generated 2020-03-02
Links: Table of Contents | QA Report | Search | Version History external | | Propose a change