FHIR Implementation Guide for NDHM CI Build v2.0
banner

NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.

StructureDefinition-Practitioner

This profile sets minimum expectations for the Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Practitioner

This profile builds on Practitioner

Summary

Mandatory: 3 elements (8 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 1 element

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... identifier S1..*IdentifierAn identifier for the person as this agent
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S1..1CodeableConceptDescription of identifier
..... coding S0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S0..1stringPlain text representation of the concept
.... system S0..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
.... assigner
..... display S0..1stringText alternative for the resource
... name S0..*HumanNameThe name(s) associated with the practitioner
.... text 1..1stringText representation of the full name
... telecom S0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
... address S0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender S0..1codemale | female | other | unknown
... birthDate S0..1dateThe date on which the practitioner was born
... photo
.... contentType 1..1codeMime type of the content, with charset etc.
.... data 1..1base64BinaryData inline, base64ed
... qualification
.... code
..... coding S0..*CodingCode defined by a terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S0..1stringPlain text representation of the concept

doco Documentation for this format
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
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 SΣI1..*IdentifierAn identifier for the person as this agent
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI1..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringPlain text representation of the concept
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI1..1stringThe value that is unique
Example General: 123456
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... display SΣI0..1stringText alternative for the resource
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name SΣI0..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ΣI1..1stringText representation of the full name
.... family ΣI0..1stringFamily name (often called 'Surname')
.... given ΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣI0..1PeriodTime period when name was/is in use
... telecom SΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI1..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... address SΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender SΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType ΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Example General: text/plain; charset=UTF-8, image/png
.... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
Example General: en-AU
.... data I1..1base64BinaryData inline, base64ed
.... url ΣI0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
.... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
.... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation ΣI0..1dateTimeDate attachment was first created
... 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)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI1..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringPlain text representation of the concept
.... 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

Summary

Mandatory: 3 elements (8 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 1 element

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... identifier S1..*IdentifierAn identifier for the person as this agent
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S1..1CodeableConceptDescription of identifier
..... coding S0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S0..1stringPlain text representation of the concept
.... system S0..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
.... assigner
..... display S0..1stringText alternative for the resource
... name S0..*HumanNameThe name(s) associated with the practitioner
.... text 1..1stringText representation of the full name
... telecom S0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value 1..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
... address S0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender S0..1codemale | female | other | unknown
... birthDate S0..1dateThe date on which the practitioner was born
... photo
.... contentType 1..1codeMime type of the content, with charset etc.
.... data 1..1base64BinaryData inline, base64ed
... qualification
.... code
..... coding S0..*CodingCode defined by a terminology system
...... code 1..1codeSymbol in syntax defined by the system
...... display 1..1stringRepresentation defined by the system
..... text S0..1stringPlain text representation of the concept

doco Documentation for this format

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
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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 SΣI1..*IdentifierAn identifier for the person as this agent
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣI1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI1..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringPlain text representation of the concept
.... system SΣI0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI1..1stringThe value that is unique
Example General: 123456
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
..... type ΣI0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
..... identifier ΣI0..1IdentifierLogical reference, when literal reference is not known
..... display SΣI0..1stringText alternative for the resource
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name SΣI0..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ΣI1..1stringText representation of the full name
.... family ΣI0..1stringFamily name (often called 'Surname')
.... given ΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣI0..1PeriodTime period when name was/is in use
... telecom SΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI1..1stringThe actual contact point details
.... use ?!SΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... address SΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender SΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contentType ΣI1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required)
Example General: text/plain; charset=UTF-8, image/png
.... language ΣI0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
Example General: en-AU
.... data I1..1base64BinaryData inline, base64ed
.... url ΣI0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size ΣI0..1unsignedIntNumber of bytes of content (if url provided)
.... hash ΣI0..1base64BinaryHash of the data (sha-1, base64ed)
.... title ΣI0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... creation ΣI0..1dateTimeDate attachment was first created
... 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)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI1..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text SΣI0..1stringPlain text representation of the concept
.... 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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron