HL7.FHIR.US.VR-COMMON-LIBRARY\Practitioner - Live Birth and Fetal Death

Vital Records Common Profiles Library
1.0.0 - STU 1

This page is part of the Vital Records Common Profile Library (v1.0.0: STU 1 on FHIR R4) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Practitioner - Live Birth and Fetal Death

Defining URL:

http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Practitioner-vital-records

Version:

1.0.0

Name:

PractitionerVitalRecords

Title:

Practitioner - VitalRecords

Status:

Draft as of 2021-10-12T12:37:45+00:00

Definition:

This Practitioner profile represents a practitioner who is involved in vital records (births, fetal death, death, etc.) as a certifier or an attendant. This profile is based on the US Core Practitioner and adds a further constraint to capture the title of the practitioner.

Publisher:

HL7 International - Public Health Work Group

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Practitioner-vital-records

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 1 element

This structure is derived from USCorePractitionerProfile

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
qualification	S	0..1	BackboneElement	Certification, licenses, or training pertaining to the provision of care
code		1..1	CodeableConcept	List of titles Binding: Birth Attendant Titles (NCHS) (required): Live Birth/Fetal Death Practitioner title
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Practitioner		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	Σ	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) Max Binding: AllLanguages: A human language.
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Σ	1..*	Identifier	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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
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)
identifier:NPI	SΣ	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	Σ	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
Slices for 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	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
address	Σ	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
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	S	0..1	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	List of titles Binding: Birth Attendant Titles (NCHS) (required): Live Birth/Fetal Death Practitioner title
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) Max Binding: AllLanguages: A human language.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
Slices for identifier	Σ	1..*	Identifier	An identifier for the person as this agent Slice: Unordered, Open by pattern:$this
identifier:All Slices				Content/Rules for all slices
system	Σ	1..1	uri	The namespace for the identifier value
value	Σ	1..1	string	The value that is unique
identifier:NPI	Σ	0..1	Identifier	An identifier for the person as this agent Required Pattern: At least the following
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi
name	Σ	1..*	HumanName	The name(s) associated with the practitioner
family	Σ	1..1	string	Family name (often called 'Surname')
qualification		0..1	BackboneElement	Certification, licenses, or training pertaining to the provision of care
Documentation for this format

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 1 element

Differential View

This structure is derived from USCorePractitionerProfile

Name	Flags	Card.	Type	Description & Constraints
Practitioner		0..*	USCorePractitionerProfile	A person with a formal responsibility in the provisioning of healthcare or related services
qualification	S	0..1	BackboneElement	Certification, licenses, or training pertaining to the provision of care
code		1..1	CodeableConcept	List of titles Binding: Birth Attendant Titles (NCHS) (required): Live Birth/Fetal Death Practitioner title
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Practitioner		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	Σ	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) Max Binding: AllLanguages: A human language.
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Σ	1..*	Identifier	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
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
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)
identifier:NPI	SΣ	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	Σ	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
Slices for 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	Σ	0..*	ContactPoint	A contact detail for the practitioner (that apply to all roles)
address	Σ	0..*	Address	Address(es) of the practitioner that are not role specific (typically home address)
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	S	0..1	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	List of titles Binding: Birth Attendant Titles (NCHS) (required): Live Birth/Fetal Death Practitioner title
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) Max Binding: AllLanguages: A human language.
Documentation for this format

Other representations of profile: CSV, Excel, 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.gender	required	AdministrativeGender
Practitioner.qualification.code	required	PHVS_BirthAttendantTitles_NCHS
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.address	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 © 2020+ HL7 International - Public Health Work Group. Package hl7.fhir.us.vr-common-library#1.0.0 based on FHIR 4.0.1. Generated 2021-10-12
Links: Table of Contents | QA Report | Version History | Search | | Propose a change