DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.4.14.3 StructureDefinition: USLabPHPract

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/pract-uslab-uslabphpract

USLab Practitioner

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.

5.4.14.3.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: 8 elements, Must-Support: 22 elements, Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1PractitionerUSLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier S I0..1Identifier
.... use S1..1
.... system S1..1uriOID for National Provider Identifier (NPI)
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1NPI Provider Number
... name S I0..1HumanName
.... family S1..1
.... given S0..2
.... prefix S0..1
.... suffix S0..1
... telecom S0..2
.... system S1..1
.... value S1..1
... address S0..1Address
.... use S0..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required)
.... postalCode S I0..1US 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..1ISO 3166 3 letter Country Code
Binding: USCountry (extensible)
.... us-core-county S0..1stringCounty/Parish FIPS codes
Binding: USFIPSCounty (required)
... practitionerRole S1..1
.... managingOrganization S1..1org-uslab-uslaborderfacilityOrderer's Organization
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1PractitionerUSLab 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: Language (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 ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... system S1..1uriOID for National Provider Identifier (NPI)
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1stringNPI Provider Number
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S Σ0..1HumanNameA name associated with the person
.... 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 S1..1stringFamily name (often called 'Surname')
.... given S0..2stringGiven names (not always 'first'). Includes middle names
.... prefix S0..1stringParts that come before the name
.... suffix S0..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
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?!0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S Σ0..1AddressWhere practitioner can be found/visited
.... us-core-county S0..1stringCounty/Parish FIPS codes
Binding: USFIPSCounty (required)
.... use ?! S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (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 S0..1stringISO 3166 3 letter Country Code
Binding: USCountry (extensible)
.... 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 of birth for the practitioner
... photo 0..*AttachmentImage of the person
... practitionerRole S1..1The list of Roles/Organizations that the Practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... managingOrganization S1..1org-uslab-uslaborderfacilityOrderer's Organization
.... role Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*LocationThe location(s) at which this practitioner provides care
.... healthcareService 0..*HealthcareServiceThe list of healthcare services that this worker provides for this role's Organization/Location(s)
... qualification 0..*Qualifications 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: Qualification (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1OrganizationOrganization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: Language (required)

todo

This structure is derived from Practitioner.

Summary

Mandatory: 8 elements, Must-Support: 22 elements, Fixed Value: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1PractitionerUSLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier S I0..1Identifier
.... use S1..1
.... system S1..1uriOID for National Provider Identifier (NPI)
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1NPI Provider Number
... name S I0..1HumanName
.... family S1..1
.... given S0..2
.... prefix S0..1
.... suffix S0..1
... telecom S0..2
.... system S1..1
.... value S1..1
... address S0..1Address
.... use S0..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required)
.... postalCode S I0..1US 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..1ISO 3166 3 letter Country Code
Binding: USCountry (extensible)
.... us-core-county S0..1stringCounty/Parish FIPS codes
Binding: USFIPSCounty (required)
... practitionerRole S1..1
.... managingOrganization S1..1org-uslab-uslaborderfacilityOrderer's Organization

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1PractitionerUSLab 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: Language (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 ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... system S1..1uriOID for National Provider Identifier (NPI)
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1stringNPI Provider Number
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S Σ0..1HumanNameA name associated with the person
.... 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 S1..1stringFamily name (often called 'Surname')
.... given S0..2stringGiven names (not always 'first'). Includes middle names
.... prefix S0..1stringParts that come before the name
.... suffix S0..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
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?!0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S Σ0..1AddressWhere practitioner can be found/visited
.... us-core-county S0..1stringCounty/Parish FIPS codes
Binding: USFIPSCounty (required)
.... use ?! S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (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 S0..1stringISO 3166 3 letter Country Code
Binding: USCountry (extensible)
.... 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 of birth for the practitioner
... photo 0..*AttachmentImage of the person
... practitionerRole S1..1The list of Roles/Organizations that the Practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... managingOrganization S1..1org-uslab-uslaborderfacilityOrderer's Organization
.... role Σ0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
.... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*LocationThe location(s) at which this practitioner provides care
.... healthcareService 0..*HealthcareServiceThe list of healthcare services that this worker provides for this role's Organization/Location(s)
... qualification 0..*Qualifications 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: Qualification (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1OrganizationOrganization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: Language (required)

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

5.4.14.3.2 Terminology Bindings

PathNameConformanceValueSet
Practitioner.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Practitioner.identifier.useIdentifierUserequiredIdentifierUse
Practitioner.identifier.typeIdentifierTypeextensibleIdentifier Type Codes
Practitioner.name.useNameUserequiredNameUse
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.address.extension
http://hl7.org/fhir/StructureDefinition/us-core-county		USFIPSCountyrequiredUS counties and county equivalent entities codes
Practitioner.address.useAddressUserequiredAddressUse
Practitioner.address.stateUSPSStaterequiredUSPS Two Letter Alphabetic Codes
Practitioner.address.countryUSCountryextensiblehttp://www.iso.org/iso/country_codes.htm
Practitioner.genderAdministrativeGenderrequiredAdministrativeGender
Practitioner.practitionerRole.rolePractitionerRoleexamplePractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.qualification.codeQualificationexampleANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2
Practitioner.communicationLanguagerequiredhttp://tools.ietf.org/html/bcp47

5.4.14.3.3 Constraints

IdPathNameDetails
inv-1PractitionerNameandorIDShall have Organization.name and/or Organization.identifier.
XPath: exists(f:name) or exists(f:identifier)
inv-2Practitioner.address.postalCodeRegex for Zip(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} )
.