STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

J.?? StructureDefinition: Argonaut Provider Directory Practitioner Profile

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/argonaut-provider

Argonaut Profile on Practitioner Resource to support the Provider Directory Project

This profile was published on [no date] with unknown status '" by .

J.??.1 Formal Views of Profile Content

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

This structure is derived from Practitioner.

Summary

Mandatory: 2 elements (+20 nested mandatory elements)
Must-Support: 47 elements
Fixed Value: 17 elements
Prohibited: 39 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of system (Open at End)
  • There is a slice with no discriminator at Practitioner.name.given
  • The element Practitioner.telecom is sliced based on the values of system (Open at End)
  • There is a slice with no discriminator at Practitioner.address.line

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... identifier ∑IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End, by system
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.dea.gov/
.... value S ∑0..1stringThe value that is unique
Example: AB2345690
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://example.org/DentistLicenseNumber
.... value S ∑0..1stringThe value that is unique
Example: 123
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicaid.gov
.... value S ∑0..1stringThe value that is unique
Example: 21123
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicare.gov
.... value S ∑0..1stringThe value that is unique
Example: 23432
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S ∑0..1stringThe value that is unique
Example: 1369569128
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-ssn
.... value S ∑0..1stringThe value that is unique
Example: 983232323
.... assigner ∑0..0
... active S ∑0..0
... name S ∑0..1HumanNameA name associated with the person
.... use ?! ∑0..0
.... text ∑0..0
.... family S ∑1..1stringLast Name
Example: Jones
.... given ∑stringGiven names (not always 'first'). Includes middle names
Slice: Unordered, Open At End, by
.... given S ∑1..1stringFirst Name
Example: Bob
.... given S ∑0..1stringMiddle Name
Example: M
.... prefix S ∑0..1stringName Prefix
Example: Dr
.... suffix S ∑0..1stringName Suffix
Example: MD
.... period ∑0..0
... telecom ∑ContactPointA contact detail for the practitioner
Slice: Unordered, Open At End, by system, use
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: email
.... value ∑1..1stringThe actual contact point details
Example: example@surescripts.com
.... use ?! ∑0..0
.... period ∑0..0
.... us-core-direct S0..1booleanEmail is a "direct" email
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: fax
.... value S ∑1..1stringThe actual contact point details
Example: 6518553001
.... use ?! ∑0..0
.... period ∑0..0
... telecom ∑0..*ContactPointA contact detail for the practitioner
.... system ∑ I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! ∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: home
.... period ∑0..0
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: mobile
.... period ∑0..0
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: work
.... period ∑0..0
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: pager
.... value S ∑0..1stringThe actual contact point details
Example: 6122765459
.... use ?! ∑0..0
.... period ∑0..0
... address ∑0..1AddressWhere practitioner can be found/visited
.... use ?! ∑1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Fixed Value: work
.... type ∑1..1codepostal | physical | both
Binding: AddressType (required)
Fixed Value: physical
.... text ∑0..0
.... line ∑stringStreet name, number, direction & P.O. Box etc.
Slice: Ordered, Closed, by
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: 920 Second Ave S
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: Suite 400
.... city ∑0..1stringName of city, town etc.
Example: Minneapolis
.... district ∑0..0
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Example: MN
.... postalCode ∑0..1stringPostal code for area
Example: 55402
.... country ∑0..0
.... period ∑0..0
... photo 0..0
... practitionerRole S1..1BackboneElementRoles/organizations the practitioner is associated with
.... organization S1..1Reference(Organization)Organization where the roles are performed
..... reference S ∑I1..1stringRelative, internal or absolute URL reference
Example: Organization/32029
..... display S ∑1..1stringCommon Name of Organization
Example: Directory46 Clinic
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... text S ∑0..1stringPlain text representation of the concept
Example: Doctor
.... period ∑0..0
... qualification 0..0
... communication 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... 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: IETF BCP-47 (required)
... 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 ∑IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End, by system
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.dea.gov/
.... value S ∑0..1stringThe value that is unique
Example: AB2345690
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://example.org/DentistLicenseNumber
.... value S ∑0..1stringThe value that is unique
Example: 123
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicaid.gov
.... value S ∑0..1stringThe value that is unique
Example: 21123
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicare.gov
.... value S ∑0..1stringThe value that is unique
Example: 23432
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S ∑0..1stringThe value that is unique
Example: 1369569128
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-ssn
.... value S ∑0..1stringThe value that is unique
Example: 983232323
.... period ∑0..1PeriodTime period when id is/was valid for use
... name S ∑0..1HumanNameA name associated with the person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... family S ∑1..1stringLast Name
Example: Jones
.... given ∑stringGiven names (not always 'first'). Includes middle names
Slice: Unordered, Open At End, by
.... given S ∑1..1stringFirst Name
Example: Bob
.... given S ∑0..1stringMiddle Name
Example: M
.... prefix S ∑0..1stringName Prefix
Example: Dr
.... suffix S ∑0..1stringName Suffix
Example: MD
... telecom ∑ContactPointA contact detail for the practitioner
Slice: Unordered, Open At End, by system, use
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... us-core-direct S0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: email
.... value ∑1..1stringThe actual contact point details
Example: example@surescripts.com
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: fax
.... value S ∑1..1stringThe actual contact point details
Example: 6518553001
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system ∑ I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! ∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: home
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: mobile
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: work
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: pager
.... value S ∑0..1stringThe actual contact point details
Example: 6122765459
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... address ∑0..1AddressWhere practitioner can be found/visited
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Fixed Value: work
.... type ∑1..1codepostal | physical | both
Binding: AddressType (required)
Fixed Value: physical
.... line ∑stringStreet name, number, direction & P.O. Box etc.
Slice: Ordered, Closed, by
Example: 137 Nowhere Street
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: 920 Second Ave S
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: Suite 400
.... city ∑0..1stringName of city, town etc.
Example: Minneapolis
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Example: MN
.... postalCode ∑0..1stringPostal code for area
Example: 55402
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑0..1dateThe date on which the practitioner was born
... practitionerRole S1..1BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S1..1Reference(Organization)Organization where the roles are performed
..... 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: IETF BCP-47 (required)
..... 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 ∑ I0..*IdentifierIdentifies this organization across multiple systems
..... active ?! ∑0..1booleanWhether the organization's record is still in active use
..... type ∑0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
..... name ∑ I0..1stringName used for the organization
..... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
..... partOf ∑0..1Reference(Organization)The organization of which this organization forms a part
..... contact 0..*BackboneElementContact for the organization for a certain purpose
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
...... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
...... name 0..1HumanNameA name associated with the contact
...... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
...... address 0..1AddressVisiting or postal addresses for the contact
.... role ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding ∑0..*CodingCode defined by a terminology system
..... text S ∑0..1stringPlain text representation of the concept
Example: Doctor
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... location 0..*Reference(Location)The location(s) at which this practitioner provides care
.... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)

doco Documentation for this format

todo

This structure is derived from Practitioner.

Summary

Mandatory: 2 elements (+20 nested mandatory elements)
Must-Support: 47 elements
Fixed Value: 17 elements
Prohibited: 39 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of system (Open at End)
  • There is a slice with no discriminator at Practitioner.name.given
  • The element Practitioner.telecom is sliced based on the values of system (Open at End)
  • There is a slice with no discriminator at Practitioner.address.line

Differential View

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... identifier ∑IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End, by system
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.dea.gov/
.... value S ∑0..1stringThe value that is unique
Example: AB2345690
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://example.org/DentistLicenseNumber
.... value S ∑0..1stringThe value that is unique
Example: 123
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicaid.gov
.... value S ∑0..1stringThe value that is unique
Example: 21123
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicare.gov
.... value S ∑0..1stringThe value that is unique
Example: 23432
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S ∑0..1stringThe value that is unique
Example: 1369569128
.... assigner ∑0..0
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... use ?! ∑0..0
.... type ∑0..0
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-ssn
.... value S ∑0..1stringThe value that is unique
Example: 983232323
.... assigner ∑0..0
... active S ∑0..0
... name S ∑0..1HumanNameA name associated with the person
.... use ?! ∑0..0
.... text ∑0..0
.... family S ∑1..1stringLast Name
Example: Jones
.... given ∑stringGiven names (not always 'first'). Includes middle names
Slice: Unordered, Open At End, by
.... given S ∑1..1stringFirst Name
Example: Bob
.... given S ∑0..1stringMiddle Name
Example: M
.... prefix S ∑0..1stringName Prefix
Example: Dr
.... suffix S ∑0..1stringName Suffix
Example: MD
.... period ∑0..0
... telecom ∑ContactPointA contact detail for the practitioner
Slice: Unordered, Open At End, by system, use
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: email
.... value ∑1..1stringThe actual contact point details
Example: example@surescripts.com
.... use ?! ∑0..0
.... period ∑0..0
.... us-core-direct S0..1booleanEmail is a "direct" email
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: fax
.... value S ∑1..1stringThe actual contact point details
Example: 6518553001
.... use ?! ∑0..0
.... period ∑0..0
... telecom ∑0..*ContactPointA contact detail for the practitioner
.... system ∑ I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! ∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: home
.... period ∑0..0
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: mobile
.... period ∑0..0
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: work
.... period ∑0..0
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... system S ∑I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: pager
.... value S ∑0..1stringThe actual contact point details
Example: 6122765459
.... use ?! ∑0..0
.... period ∑0..0
... address ∑0..1AddressWhere practitioner can be found/visited
.... use ?! ∑1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Fixed Value: work
.... type ∑1..1codepostal | physical | both
Binding: AddressType (required)
Fixed Value: physical
.... text ∑0..0
.... line ∑stringStreet name, number, direction & P.O. Box etc.
Slice: Ordered, Closed, by
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: 920 Second Ave S
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: Suite 400
.... city ∑0..1stringName of city, town etc.
Example: Minneapolis
.... district ∑0..0
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Example: MN
.... postalCode ∑0..1stringPostal code for area
Example: 55402
.... country ∑0..0
.... period ∑0..0
... photo 0..0
... practitionerRole S1..1BackboneElementRoles/organizations the practitioner is associated with
.... organization S1..1Reference(Organization)Organization where the roles are performed
..... reference S ∑I1..1stringRelative, internal or absolute URL reference
Example: Organization/32029
..... display S ∑1..1stringCommon Name of Organization
Example: Directory46 Clinic
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... text S ∑0..1stringPlain text representation of the concept
Example: Doctor
.... period ∑0..0
... qualification 0..0
... communication 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... 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: IETF BCP-47 (required)
... 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 ∑IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End, by system
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.dea.gov/
.... value S ∑0..1stringThe value that is unique
Example: AB2345690
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://example.org/DentistLicenseNumber
.... value S ∑0..1stringThe value that is unique
Example: 123
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicaid.gov
.... value S ∑0..1stringThe value that is unique
Example: 21123
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://www.medicare.gov
.... value S ∑0..1stringThe value that is unique
Example: 23432
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S ∑0..1stringThe value that is unique
Example: 1369569128
.... period ∑0..1PeriodTime period when id is/was valid for use
... identifier ∑0..*IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑0..1uriThe namespace for the identifier
Fixed Value: http://hl7.org/fhir/sid/us-ssn
.... value S ∑0..1stringThe value that is unique
Example: 983232323
.... period ∑0..1PeriodTime period when id is/was valid for use
... name S ∑0..1HumanNameA name associated with the person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... family S ∑1..1stringLast Name
Example: Jones
.... given ∑stringGiven names (not always 'first'). Includes middle names
Slice: Unordered, Open At End, by
.... given S ∑1..1stringFirst Name
Example: Bob
.... given S ∑0..1stringMiddle Name
Example: M
.... prefix S ∑0..1stringName Prefix
Example: Dr
.... suffix S ∑0..1stringName Suffix
Example: MD
... telecom ∑ContactPointA contact detail for the practitioner
Slice: Unordered, Open At End, by system, use
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... us-core-direct S0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-direct
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: email
.... value ∑1..1stringThe actual contact point details
Example: example@surescripts.com
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: fax
.... value S ∑1..1stringThe actual contact point details
Example: 6518553001
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system ∑ I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! ∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: home
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: mobile
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: phone
.... value S ∑1..1stringThe actual contact point details
Example: 6122765459
.... use ?! S∑1..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Fixed Value: work
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... telecom S ∑0..*ContactPointA contact detail for the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
Fixed Value: pager
.... value S ∑0..1stringThe actual contact point details
Example: 6122765459
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
... address ∑0..1AddressWhere practitioner can be found/visited
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Fixed Value: work
.... type ∑1..1codepostal | physical | both
Binding: AddressType (required)
Fixed Value: physical
.... line ∑stringStreet name, number, direction & P.O. Box etc.
Slice: Ordered, Closed, by
Example: 137 Nowhere Street
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: 920 Second Ave S
.... line S ∑0..1stringStreet name, number, direction & P.O. Box etc.
Example: Suite 400
.... city ∑0..1stringName of city, town etc.
Example: Minneapolis
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Example: MN
.... postalCode ∑0..1stringPostal code for area
Example: 55402
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑0..1dateThe date on which the practitioner was born
... practitionerRole S1..1BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S1..1Reference(Organization)Organization where the roles are performed
..... 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: IETF BCP-47 (required)
..... 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 ∑ I0..*IdentifierIdentifies this organization across multiple systems
..... active ?! ∑0..1booleanWhether the organization's record is still in active use
..... type ∑0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
..... name ∑ I0..1stringName used for the organization
..... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
..... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
..... partOf ∑0..1Reference(Organization)The organization of which this organization forms a part
..... contact 0..*BackboneElementContact for the organization for a certain purpose
...... extension 0..*ExtensionAdditional Content defined by implementations
...... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
...... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
...... name 0..1HumanNameA name associated with the contact
...... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
...... address 0..1AddressVisiting or postal addresses for the contact
.... role ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding ∑0..*CodingCode defined by a terminology system
..... text S ∑0..1stringPlain text representation of the concept
Example: Doctor
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... location 0..*Reference(Location)The location(s) at which this practitioner provides care
.... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

J.??.2 Terminology Bindings

PathNameConformanceValueSet
Practitioner.language?extrequiredhttp://tools.ietf.org/html/bcp47
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.address.useAddressUserequiredAddressUse
Practitioner.address.typeAddressTyperequiredAddressType
Practitioner.genderAdministrativeGenderrequiredAdministrativeGender
Practitioner.practitionerRole.organization.language?extrequiredhttp://tools.ietf.org/html/bcp47
Practitioner.practitionerRole.organization.typeOrganizationTypeexampleOrganizationType
Practitioner.practitionerRole.organization.contact.purposeContactEntityTypeextensibleContactEntityType
Practitioner.practitionerRole.rolePractitionerRoleexamplePractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.qualification.codeANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2exampleANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2

J.??.3 Constraints

IdPathDetailsRequirements
org-3Practitioner.practitionerRole.organization.telecomThe telecom of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
org-2Practitioner.practitionerRole.organization.addressAn address of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
.