2nd DSTU Draft For Comment

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

Profile: USLabPHPract

The official URL for this profile is: 

http://hl7.org/fhir/Profile/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.

Generating text summary of fixed value not yet done for type org.hl7.fhir.instance.model.Identifier

Formal Views of Profile Content

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

Differential View

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1USLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... text S1..1
.... status S1..1codeFixed Value: generated
... identifier S I0..1IdentifierRequired Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... 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, extensible)
.... 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: USLabCountry (required, extensible)
.... us-core-county S0..1stringCounty/Parish FIPS codes
..... extension S1..1CodingBinding: USFIPSCounty (required, not extensible)
...... system S1..1
...... code S1..1
... practitionerRole S1..1
.... managingOrganization S1..1org-uslab-uslaborderfacilityOrderer's Organization

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1USLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... 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
Required Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... system 0..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required, not extensible)
.... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value S1..1stringThe actual contact point details
.... use M0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S Σ0..1AddressWhere practitioner can be found/visited
.... id 0..1idxml:id (or equivalent in JSON)
.... us-core-county S0..1stringCounty/Parish FIPS codes
..... id 0..1idxml:id (or equivalent in JSON)
..... extension S1..1CodingAdditional Content defined by implementations
Binding: USFIPSCounty (required, not extensible)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriIdentity of the terminology system
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSymbol in syntax defined by the system
...... display 0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... use M S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
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, extensible)
.... 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: USLabCountry (required, 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, not extensible)
... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... 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, extensible)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example, extensible)
.... 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 offers at this location of this organization
... qualification 0..*Qualifications obtained by training and certification
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: Qualification (example, extensible)
.... 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, not extensible)

XML Template

JSON Template

todo

Differential View

This structure is derived from Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1USLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... text S1..1
.... status S1..1codeFixed Value: generated
... identifier S I0..1IdentifierRequired Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... 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, extensible)
.... 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: USLabCountry (required, extensible)
.... us-core-county S0..1stringCounty/Parish FIPS codes
..... extension S1..1CodingBinding: USFIPSCounty (required, not extensible)
...... system S1..1
...... code S1..1
... practitionerRole S1..1
.... managingOrganization S1..1org-uslab-uslaborderfacilityOrderer's Organization

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I1..1USLab Practitioner
inv-1: Shall have Organization.name and/or Organization.identifier.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... 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
Required Pattern: {"use":"official","label":"NPI","assigner":{"reference":"https://nppes.cms.hhs.gov/NPPES/","display":"The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"}}
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... system 0..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required, not extensible)
.... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required, not extensible)
.... value S1..1stringThe actual contact point details
.... use M0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required, not extensible)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S Σ0..1AddressWhere practitioner can be found/visited
.... id 0..1idxml:id (or equivalent in JSON)
.... us-core-county S0..1stringCounty/Parish FIPS codes
..... id 0..1idxml:id (or equivalent in JSON)
..... extension S1..1CodingAdditional Content defined by implementations
Binding: USFIPSCounty (required, not extensible)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S1..1uriIdentity of the terminology system
...... version 0..1stringVersion of the system - if relevant
...... code S1..1codeSymbol in syntax defined by the system
...... display 0..1stringRepresentation defined by the system
...... primary 0..1booleanIf this code was chosen directly by the user
...... valueSet 0..1ValueSetSet this coding was chosen from
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... use M S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
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, extensible)
.... 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: USLabCountry (required, 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, not extensible)
... 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
.... id 0..1idxml:id (or equivalent in JSON)
.... 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, extensible)
.... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example, extensible)
.... 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 offers at this location of this organization
... qualification 0..*Qualifications obtained by training and certification
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: Qualification (example, extensible)
.... 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, not extensible)

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Practitioner.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Practitioner.text.statusNarrativeStatusrequiredNarrativeStatus
Practitioner.identifier.useIdentifierUserequiredIdentifierUse
Practitioner.name.useNameUserequiredNameUse
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.address.extension.extensionUSFIPSCountyrequiredUS counties and county equivalent entities codes
Practitioner.address.useAddressUserequiredAddressUse
Practitioner.address.stateUSPSStaterequired (extensible)USPS Two Letter Alphabetic Codes
Practitioner.address.countryUSLabCountryrequired (extensible)USLabCountry
Practitioner.genderAdministrativeGenderrequiredAdministrativeGender
Practitioner.practitionerRole.rolePractitionerRoleexample (extensible)PractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexample (extensible)PractitionerSpecialty
Practitioner.qualification.codeQualificationexample (extensible)ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2
Practitioner.communicationLanguagerequiredhttp://tools.ietf.org/html/bcp47

Constraints

IdPathNameDetails
inv-1PractitionerNameandorIDShall have Organization.name and/or Organization.identifier.
XPath: exists(f:name) or exists(f:identifier)
txt-2Practitioner.text.divThe narrative SHALL have some non-whitespace content
XPath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]
txt-1Practitioner.text.divThe narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))])
txt-3Practitioner.text.divThe narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])
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} )
.