Argonaut Provider Directory Implementation Guide Version 1.0.0

This page is part of the Argonaut Provider Directory Guide (v1.0.0: Release) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

SD.4 StructureDefinition-argo-practitioner

This profile sets minimum expectations for the Practitioner resource to record [content] associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Practitioner must have:

  1. An identifier (NPI preferred)
  2. A name

Profile specific implementation guidance:

  • none
Examples

SD.4.1 Formal Views of Profile Content

The official URL for this profile is: 

http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-practitioner

This profile builds on Practitioner.

This profile was published on Wed Nov 09 00:00:00 AEDT 2016 as a draft by Argonaut Project.

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

Complete Summary of the Mandatory Requirements

  1. At least one (non-local) identifier in Practitioner.identifier
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to authoritative identifier
  2. One name in Practitioner.name
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*Argonaut Provider Directory Practitioner
... identifier S1..*Identifier
.... system S1..1uriNPI could be used as the identifier system in the US.
Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... value S1..1string
... name S1..1HumanName
.... family S1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*Argonaut Provider Directory Practitioner
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierA identifier for the person as this agent
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriNPI could be used as the identifier system in the US.
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... value SΣ1..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..1HumanNameThe name(s) associated with the practitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: Common Languages (extensible)

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. At least one (non-local) identifier in Practitioner.identifier
    • NPI preferred
    • Tax id is allowed
    • Local id is allowed in addition to authoritative identifier
  2. One name in Practitioner.name

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*Argonaut Provider Directory Practitioner
... identifier S1..*Identifier
.... system S1..1uriNPI could be used as the identifier system in the US.
Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... value S1..1string
... name S1..1HumanName
.... family S1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*Argonaut Provider Directory Practitioner
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierA identifier for the person as this agent
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriNPI could be used as the identifier system in the US.
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier
.... value SΣ1..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..1HumanNameThe name(s) associated with the practitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: Common Languages (extensible)

doco Documentation for this format

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

 

SD.4.2 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for a complete list of supported RESTful operations and search parameters for this IG.

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

Example: GET [base]/Practitioner?identifier=http://hl7.org/fhir/STU3/sid/us-npi|1497860456

Support: Mandatory to search by identifier.

Implementation Notes: Search based on practitioner identifier (how to search by token).

GET [base]/Practitioner?family=[string]&given=[string]

Example: GET [base]/Practitioner?family=Smith&given=John

Support: Mandatory to support search by Practitioner name.

Implementation Notes: Search based on text name (how to search by string).