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

A.9.2.0 StructureDefinition: USLab-PHPract

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/uslab-phpract

USLab Practitioner

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Orders and Observations - US Lab).

A.9.2.0.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 (+6 nested mandatory elements)
Must-Support: 22 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerUSLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier S I0..1Identifier
.... use S1..1code
.... system S1..1uriOID for National Provider Identifier (NPI)
Fixed Value: http://hl7.org.fhir/sid/us-npi
.... value S1..1stringNPI Provider Number
... name S I0..1HumanName
.... family S1..1string
.... given S0..2string
.... prefix S0..1string
.... suffix S0..1string
... telecom S0..2ContactPoint
.... system S1..1code
.... value S1..1string
... address S0..1Address
.... use S0..1code
.... line S0..2string
.... city S0..1string
.... district S0..1stringCounty/Parish FIPS codes
Binding: US counties and county equivalent entities codes (required)
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
... practitionerRole S1..1BackboneElement
.... organization S1..1Reference(US Laboratory Organization Profile)Orderer's Organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerUSLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... 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 S ∑0..1IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriOID for National Provider Identifier (NPI)
Fixed Value: http://hl7.org.fhir/sid/us-npi
.... value S ∑1..1stringNPI Provider Number
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ∑0..1booleanWhether this practitioner's record is in active use
... name S ∑0..1HumanNameThe name(s) associated with the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S ∑1..1stringFamily name (often called 'Surname')
.... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
.... prefix S ∑0..1stringParts that come before the name
.... suffix S ∑0..1stringParts that come after the name
.... period ∑0..1PeriodTime period when name was/is in use
... telecom S ∑0..2ContactPointA contact detail for the practitioner (that apply to all roles)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... address S ∑0..1AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑0..2stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑0..1stringName of city, town etc.
Example: Erewhon
.... district S ∑0..1stringCounty/Parish FIPS codes
Binding: US counties and county equivalent entities codes (required)
Example: Madison
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S ∑I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S ∑0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... 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(US Laboratory Organization Profile)Orderer's Organization
.... role ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... 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)
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: IETF BCP-47 (required)

doco Documentation for this format

todo

This structure is derived from Practitioner.

Summary

Mandatory: 2 elements (+6 nested mandatory elements)
Must-Support: 22 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerUSLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier S I0..1Identifier
.... use S1..1code
.... system S1..1uriOID for National Provider Identifier (NPI)
Fixed Value: http://hl7.org.fhir/sid/us-npi
.... value S1..1stringNPI Provider Number
... name S I0..1HumanName
.... family S1..1string
.... given S0..2string
.... prefix S0..1string
.... suffix S0..1string
... telecom S0..2ContactPoint
.... system S1..1code
.... value S1..1string
... address S0..1Address
.... use S0..1code
.... line S0..2string
.... city S0..1string
.... district S0..1stringCounty/Parish FIPS codes
Binding: US counties and county equivalent entities codes (required)
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
... practitionerRole S1..1BackboneElement
.... organization S1..1Reference(US Laboratory Organization Profile)Orderer's Organization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*PractitionerUSLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... 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 S ∑0..1IdentifierA identifier for the person as this agent
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriOID for National Provider Identifier (NPI)
Fixed Value: http://hl7.org.fhir/sid/us-npi
.... value S ∑1..1stringNPI Provider Number
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ∑0..1booleanWhether this practitioner's record is in active use
... name S ∑0..1HumanNameThe name(s) associated with the practitioner
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S ∑1..1stringFamily name (often called 'Surname')
.... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
.... prefix S ∑0..1stringParts that come before the name
.... suffix S ∑0..1stringParts that come after the name
.... period ∑0..1PeriodTime period when name was/is in use
... telecom S ∑0..2ContactPointA contact detail for the practitioner (that apply to all roles)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... address S ∑0..1AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑0..2stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑0..1stringName of city, town etc.
Example: Erewhon
.... district S ∑0..1stringCounty/Parish FIPS codes
Binding: US counties and county equivalent entities codes (required)
Example: Madison
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S ∑I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S ∑0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ∑0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... 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(US Laboratory Organization Profile)Orderer's Organization
.... role ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... 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)
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: IETF BCP-47 (required)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

A.9.2.0.2 Terminology Bindings

PathNameConformanceValueSet
Practitioner.language?extrequiredhttp://tools.ietf.org/html/bcp47
Practitioner.identifier.useIdentifierUserequiredIdentifierUse
Practitioner.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Practitioner.name.useNameUserequiredNameUse
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.address.useAddressUserequiredAddressUse
Practitioner.address.typeAddressTyperequiredAddressType
Practitioner.address.districtUS counties and county equivalent entities codesrequiredUS counties and county equivalent entities codes
Practitioner.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Practitioner.address.country?extrequiredhttp://www.iso.org/iso/country_codes.htm
Practitioner.genderAdministrativeGenderrequiredAdministrativeGender
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
Practitioner.communication?extrequiredhttp://tools.ietf.org/html/bcp47

A.9.2.0.3 Constraints

IdPathDetailsRequirements
inv-1PractitionerShall have Organization.name and/or Organization.identifier.
XPath: exists(f:name) or exists(f:identifier)
inv-2Practitioner.address.postalCode(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
.