ESMD FHIR Implementation Guide
1.0.0 - esmd
ESMD FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner | Version: 1.0.0 | |||
| Draft as of 2024-02-25 | Computable Name: EsmdPractitioner | |||
The Esmd-Practitioner profile extends the USCorePractitioner profile with additional elements to ensure that practitioner data, including personal details and esMD-specific service-related information is captured and exchanged consistently. HIHs can use this profile to submit a single provider registration request transaction for each provider.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
SΣ | 1..1 | EsmdMeta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner |
![]() ![]() ![]() |
SΣC | 1..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children inv-esmd-meta-security-01: esMD supports only V security code |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI" | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-npi-1: NPI should be 10 numeric |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId" | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-providerTaxId-1: Provider Tax ID should be 6 to 9 characters length but optional element |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber" | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-providerNumber-1: Provider Number should be 10 characters length but optional element |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Action Requested Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode" | |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ESMD ActionRequested ValueSet (required): Action Requested Codes ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Service Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ESMD Service Codes ValueSet (required) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service Start Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate" | |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension ele-1: All FHIR elements must have a @value or children esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service End Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate" | |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension ele-1: All FHIR elements must have a @value or children esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣ | 0..* | Identifier | An identifier for the person as this agent ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..1 | boolean | Whether this practitioner's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Practitioner.extension:actionRequested.value[x] | required | EsmdVSActionRequested (a valid code from Service Registration Action Requested)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ActionRequestedfrom this IG | |
| Practitioner.extension:serviceCode.value[x] | required | EsmdVSServiceCodes (a valid code from ESMD supporting Service Codes)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ServiceCodesfrom this IG | |
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| esmd-npi-1 | error | Practitioner.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-providerNumber-1 | error | Practitioner.extension:providerNumber.value[x] | Provider Number should be 10 characters length but optional element : value.exists() implies (value.matches('^.{10}$')) | |
| esmd-providerTaxId-1 | error | Practitioner.extension:providerTaxId.value[x] | Provider Tax ID should be 6 to 9 characters length but optional element : value.exists() implies (value.matches('^.{6,9}$')) | |
| esmd-servicedate-1 | error | Practitioner.extension:serviceStartDate.value[x], Practitioner.extension:serviceEndDate.value[x] | Service dates should be in YYYY-MM-DD format : value.as(date).exists() implies (value.as(date) >= today()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-esmd-meta-security-01 | error | Practitioner.meta.security | esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST') |
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
Practitioner | |||
![]() ![]() |
S | 1..1 | EsmdMeta | Metadata about the resource |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner | |
![]() ![]() ![]() |
S | 1..* | Coding | Security Labels applied to this resource |
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-npi-1: NPI should be 10 numeric |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerTaxId-1: Provider Tax ID should be 6 to 9 characters length but optional element |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerNumber-1: Provider Number should be 10 characters length but optional element |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Action Requested Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ESMD ActionRequested ValueSet (required): Action Requested Codes | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Service Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ESMD Service Codes ValueSet (required) | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service Start Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service End Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() |
S | 0..* | Identifier | An identifier for the person as this agent |
![]() ![]() |
S | 0..1 | boolean | Whether this practitioner's record is in active use |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
![]() ![]() |
S | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.extension:actionRequested.value[x] | required | EsmdVSActionRequested (a valid code from Service Registration Action Requested)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ActionRequestedfrom this IG | |
| Practitioner.extension:serviceCode.value[x] | required | EsmdVSServiceCodes (a valid code from ESMD supporting Service Codes)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ServiceCodesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| esmd-npi-1 | error | Practitioner.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-providerNumber-1 | error | Practitioner.extension:providerNumber.value[x] | Provider Number should be 10 characters length but optional element : value.exists() implies (value.matches('^.{10}$')) | |
| esmd-providerTaxId-1 | error | Practitioner.extension:providerTaxId.value[x] | Provider Tax ID should be 6 to 9 characters length but optional element : value.exists() implies (value.matches('^.{6,9}$')) | |
| esmd-servicedate-1 | error | Practitioner.extension:serviceStartDate.value[x], Practitioner.extension:serviceEndDate.value[x] | Service dates should be in YYYY-MM-DD format : value.as(date).exists() implies (value.as(date) >= today()) |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 1..1 | EsmdMeta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner | ||||
![]() ![]() ![]() |
SΣC | 1..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-esmd-meta-security-01: esMD supports only V security code | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-npi-1: NPI should be 10 numeric | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerTaxId-1: Provider Tax ID should be 6 to 9 characters length but optional element | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerNumber-1: Provider Number should be 10 characters length but optional element | ||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Action Requested Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode" | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ESMD ActionRequested ValueSet (required): Action Requested Codes | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Service Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode" | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ESMD Service Codes ValueSet (required) | |||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service Start Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service End Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | An identifier for the person as this agent | ||||
![]() ![]() |
SΣ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
![]() ![]() |
Σ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Practitioner.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Practitioner.extension:actionRequested.value[x] | required | EsmdVSActionRequested (a valid code from Service Registration Action Requested)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ActionRequestedfrom this IG | ||||
| Practitioner.extension:serviceCode.value[x] | required | EsmdVSServiceCodes (a valid code from ESMD supporting Service Codes)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ServiceCodesfrom this IG | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| esmd-npi-1 | error | Practitioner.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-providerNumber-1 | error | Practitioner.extension:providerNumber.value[x] | Provider Number should be 10 characters length but optional element : value.exists() implies (value.matches('^.{10}$')) | |
| esmd-providerTaxId-1 | error | Practitioner.extension:providerTaxId.value[x] | Provider Tax ID should be 6 to 9 characters length but optional element : value.exists() implies (value.matches('^.{6,9}$')) | |
| esmd-servicedate-1 | error | Practitioner.extension:serviceStartDate.value[x], Practitioner.extension:serviceEndDate.value[x] | Service dates should be in YYYY-MM-DD format : value.as(date).exists() implies (value.as(date) >= today()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-esmd-meta-security-01 | error | Practitioner.meta.security | esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST') |
This structure is derived from Practitioner
Summary
Mandatory: 6 elements
Must-Support: 14 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() |
SΣ | 1..1 | EsmdMeta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner |
![]() ![]() ![]() |
SΣC | 1..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children inv-esmd-meta-security-01: esMD supports only V security code |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI" | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-npi-1: NPI should be 10 numeric |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId" | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-providerTaxId-1: Provider Tax ID should be 6 to 9 characters length but optional element |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber" | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children esmd-providerNumber-1: Provider Number should be 10 characters length but optional element |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Action Requested Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode" | |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ESMD ActionRequested ValueSet (required): Action Requested Codes ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Service Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ESMD Service Codes ValueSet (required) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service Start Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate" | |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension ele-1: All FHIR elements must have a @value or children esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service End Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate" | |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension ele-1: All FHIR elements must have a @value or children esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() |
SΣ | 0..* | Identifier | An identifier for the person as this agent ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..1 | boolean | Whether this practitioner's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) ele-1: All FHIR elements must have a @value or children |
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | |
| Practitioner.extension:actionRequested.value[x] | required | EsmdVSActionRequested (a valid code from Service Registration Action Requested)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ActionRequestedfrom this IG | |
| Practitioner.extension:serviceCode.value[x] | required | EsmdVSServiceCodes (a valid code from ESMD supporting Service Codes)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ServiceCodesfrom this IG | |
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| esmd-npi-1 | error | Practitioner.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-providerNumber-1 | error | Practitioner.extension:providerNumber.value[x] | Provider Number should be 10 characters length but optional element : value.exists() implies (value.matches('^.{10}$')) | |
| esmd-providerTaxId-1 | error | Practitioner.extension:providerTaxId.value[x] | Provider Tax ID should be 6 to 9 characters length but optional element : value.exists() implies (value.matches('^.{6,9}$')) | |
| esmd-servicedate-1 | error | Practitioner.extension:serviceStartDate.value[x], Practitioner.extension:serviceEndDate.value[x] | Service dates should be in YYYY-MM-DD format : value.as(date).exists() implies (value.as(date) >= today()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-esmd-meta-security-01 | error | Practitioner.meta.security | esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST') |
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
Practitioner | |||
![]() ![]() |
S | 1..1 | EsmdMeta | Metadata about the resource |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner | |
![]() ![]() ![]() |
S | 1..* | Coding | Security Labels applied to this resource |
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-npi-1: NPI should be 10 numeric |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerTaxId-1: Provider Tax ID should be 6 to 9 characters length but optional element |
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerNumber-1: Provider Number should be 10 characters length but optional element |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Action Requested Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode |
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ESMD ActionRequested ValueSet (required): Action Requested Codes | |
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Service Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ESMD Service Codes ValueSet (required) | |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service Start Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service End Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate |
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format |
![]() ![]() |
S | 0..* | Identifier | An identifier for the person as this agent |
![]() ![]() |
S | 0..1 | boolean | Whether this practitioner's record is in active use |
![]() ![]() |
S | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
![]() ![]() |
S | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() |
0..0 | |||
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Practitioner.extension:actionRequested.value[x] | required | EsmdVSActionRequested (a valid code from Service Registration Action Requested)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ActionRequestedfrom this IG | |
| Practitioner.extension:serviceCode.value[x] | required | EsmdVSServiceCodes (a valid code from ESMD supporting Service Codes)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ServiceCodesfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| esmd-npi-1 | error | Practitioner.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-providerNumber-1 | error | Practitioner.extension:providerNumber.value[x] | Provider Number should be 10 characters length but optional element : value.exists() implies (value.matches('^.{10}$')) | |
| esmd-providerTaxId-1 | error | Practitioner.extension:providerTaxId.value[x] | Provider Tax ID should be 6 to 9 characters length but optional element : value.exists() implies (value.matches('^.{6,9}$')) | |
| esmd-servicedate-1 | error | Practitioner.extension:serviceStartDate.value[x], Practitioner.extension:serviceEndDate.value[x] | Service dates should be in YYYY-MM-DD format : value.as(date).exists() implies (value.as(date) >= today()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
SΣ | 1..1 | EsmdMeta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Practitioner | ||||
![]() ![]() ![]() |
SΣC | 1..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. inv-esmd-meta-security-01: esMD supports only V security code | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
3..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-NPI" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-npi-1: NPI should be 10 numeric | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderTaxId" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerTaxId-1: Provider Tax ID should be 6 to 9 characters length but optional element | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | Provider ID URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ProviderNumber" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Value of extension esmd-providerNumber-1: Provider Number should be 10 characters length but optional element | ||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Action Requested Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ActionRequestedCode" | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Value of extension Binding: ESMD ActionRequested ValueSet (required): Action Requested Codes | |||||
![]() ![]() ![]() |
S | 1..1 | (Complex) | esMD Service Code URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceCode" | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: ESMD Service Codes ValueSet (required) | |||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service Start Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceStartDate" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format | ||||
![]() ![]() ![]() |
S | 0..1 | (Complex) | esMD Service End Date URL: https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://terminology.esmduat.cms.gov:8099/fhir/StructureDefinition/Esmd-Ext-ServiceEndDate" | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | date | Value of extension esmd-servicedate-1: Service dates should be in YYYY-MM-DD format | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | An identifier for the person as this agent | ||||
![]() ![]() |
SΣ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
![]() ![]() |
Σ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
![]() ![]() |
SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
![]() ![]() |
SΣ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() |
Σ | 0..1 | date | The date on which the practitioner was born | ||||
![]() ![]() |
0..* | Attachment | Image of the person | |||||
![]() ![]() |
0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| Practitioner.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| Practitioner.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Practitioner.extension:actionRequested.value[x] | required | EsmdVSActionRequested (a valid code from Service Registration Action Requested)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ActionRequestedfrom this IG | ||||
| Practitioner.extension:serviceCode.value[x] | required | EsmdVSServiceCodes (a valid code from ESMD supporting Service Codes)https://terminology.esmduat.cms.gov:8099/fhir/ValueSet/Esmd-VS-ServiceCodesfrom this IG | ||||
| Practitioner.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
|
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| esmd-npi-1 | error | Practitioner.extension:npi.value[x] | NPI should be 10 numeric : value.exists() and value.matches('^[0-9]{10}$') | |
| esmd-providerNumber-1 | error | Practitioner.extension:providerNumber.value[x] | Provider Number should be 10 characters length but optional element : value.exists() implies (value.matches('^.{10}$')) | |
| esmd-providerTaxId-1 | error | Practitioner.extension:providerTaxId.value[x] | Provider Tax ID should be 6 to 9 characters length but optional element : value.exists() implies (value.matches('^.{6,9}$')) | |
| esmd-servicedate-1 | error | Practitioner.extension:serviceStartDate.value[x], Practitioner.extension:serviceEndDate.value[x] | Service dates should be in YYYY-MM-DD format : value.as(date).exists() implies (value.as(date) >= today()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-esmd-meta-security-01 | error | Practitioner.meta.security | esMD supports only V security code : code.exists() implies (code = 'V' or code = 'HTEST') |
This structure is derived from Practitioner
Summary
Mandatory: 6 elements
Must-Support: 14 elements
Fixed: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron