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

H.?? StructureDefinition: hspc-provpract

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hspc-provpract

ProviderPractitioner captures the demographic and preofessional information of a health care provider/practitioner.

This profile was published on Wed, May 13, 2015 00:00+1000 as a draft by HSPC.

H.??.1 Formal Views of Profile Content

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

This structure is derived from QICore-Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*Practitioner
... classification Binding: HSPC ProviderPractitioner Classification (preferred)
... telecom 0..*ContactPoint
.... iso21090-preferred 0..*booleanpreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... address 0..*Address
.... hspc-extensionsprimaryIndicator 0..*CodeableConceptA flag indicating prime
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
... practitionerRole BackboneElementSlice: Unordered, Open, by Practitioner.practitionerRole.organization, Practitioner.practitionerRole.role
... practitionerRole 0..*BackboneElement
.... role 0..1CodeableConceptBinding: HSPC ProviderPractitioner Type (preferred)
.... specialty 0..*CodeableConceptBinding: HSPC ProviderPractitioner Specialty (preferred)
... practitionerRole 0..*BackboneElement
... practitionerRole 0..*BackboneElement
.... hspc-extensionspracticeAffiliationType 0..*CodeableConceptAffiliationType
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspracticeAffiliationType
Binding: HSPC Practice Affiliation Type (example)
.... hspc-extensionspractitionerPrivilege 0..*CodeableConceptPractitionerPrivilege
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspractitionerPrivilege
Binding: HSPC ProviderPractitioner Privilege (preferred)
... qualification 0..*BackboneElement
.... hspc-extensionscredentialEligibilityInd 0..*CodeableConceptCredential Eligibility Indicator
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscredentialEligibilityInd
Binding: v2 Yes/no Indicator (preferred)
... communication 0..*CodeableConcept
.... hspc-extensionscommunicationMode 0..*CodeableConceptCommunicationMode
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*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
... practitioner-classification 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-classification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierA identifier for the person as this agent
... active ∑0..1booleanWhether this practitioner's record is in active use
... name ∑0..*HumanNameThe name(s) associated with the practitioner
... telecom ∑0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... iso21090-preferred 0..*booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system ∑ I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value ∑0..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 ∑0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... hspc-extensionsprimaryIndicator 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
.... use ?! ∑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 ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... gender S ∑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 BackboneElementRoles/organizations the practitioner is associated with
Slice: Unordered, Open, by Practitioner.practitionerRole.organization, Practitioner.practitionerRole.role
... practitionerRole 0..*BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S0..1Reference(QICore-Organization)Organization where the roles are performed
.... role S ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: HSPC ProviderPractitioner Type (preferred)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: HSPC ProviderPractitioner Specialty (preferred)
..... practitioner-primaryInd 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd
..... coding ∑0..*CodingCode defined by a terminology system
..... text ∑0..1stringPlain text representation of the concept
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period S ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(QICore-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)
... practitionerRole 0..*BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S0..1Reference(QICore-Organization)Organization where the roles are performed
.... role S ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... practitioner-primaryInd 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd
..... coding ∑0..*CodingCode defined by a terminology system
..... text ∑0..1stringPlain text representation of the concept
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period S ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(QICore-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)
... practitionerRole 0..*BackboneElementRoles/organizations the practitioner is associated with
.... hspc-extensionspracticeAffiliationType 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspracticeAffiliationType
Binding: HSPC Practice Affiliation Type (example)
.... hspc-extensionspractitionerPrivilege 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspractitionerPrivilege
Binding: HSPC ProviderPractitioner Privilege (preferred)
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S0..1Reference(QICore-Organization)Organization where the roles are performed
.... role S ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... practitioner-primaryInd 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd
..... coding ∑0..*CodingCode defined by a terminology system
..... text ∑0..1stringPlain text representation of the concept
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period S ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(QICore-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
.... hspc-extensionscredentialEligibilityInd 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscredentialEligibilityInd
Binding: v2 Yes/no Indicator (preferred)
.... 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(QICore-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)
.... hspc-extensionscommunicationMode 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)
.... coding ∑0..*CodingCode defined by a terminology system
.... text ∑0..1stringPlain text representation of the concept

doco Documentation for this format

todo

Differential View

This structure is derived from QICore-Practitioner.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*Practitioner
... classification Binding: HSPC ProviderPractitioner Classification (preferred)
... telecom 0..*ContactPoint
.... iso21090-preferred 0..*booleanpreferred
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
... address 0..*Address
.... hspc-extensionsprimaryIndicator 0..*CodeableConceptA flag indicating prime
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
... practitionerRole BackboneElementSlice: Unordered, Open, by Practitioner.practitionerRole.organization, Practitioner.practitionerRole.role
... practitionerRole 0..*BackboneElement
.... role 0..1CodeableConceptBinding: HSPC ProviderPractitioner Type (preferred)
.... specialty 0..*CodeableConceptBinding: HSPC ProviderPractitioner Specialty (preferred)
... practitionerRole 0..*BackboneElement
... practitionerRole 0..*BackboneElement
.... hspc-extensionspracticeAffiliationType 0..*CodeableConceptAffiliationType
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspracticeAffiliationType
Binding: HSPC Practice Affiliation Type (example)
.... hspc-extensionspractitionerPrivilege 0..*CodeableConceptPractitionerPrivilege
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspractitionerPrivilege
Binding: HSPC ProviderPractitioner Privilege (preferred)
... qualification 0..*BackboneElement
.... hspc-extensionscredentialEligibilityInd 0..*CodeableConceptCredential Eligibility Indicator
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscredentialEligibilityInd
Binding: v2 Yes/no Indicator (preferred)
... communication 0..*CodeableConcept
.... hspc-extensionscommunicationMode 0..*CodeableConceptCommunicationMode
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*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
... practitioner-classification 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-classification
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierA identifier for the person as this agent
... active ∑0..1booleanWhether this practitioner's record is in active use
... name ∑0..*HumanNameThe name(s) associated with the practitioner
... telecom ∑0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... iso21090-preferred 0..*booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system ∑ I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value ∑0..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 ∑0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... hspc-extensionsprimaryIndicator 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
.... use ?! ∑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 ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... gender S ∑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 BackboneElementRoles/organizations the practitioner is associated with
Slice: Unordered, Open, by Practitioner.practitionerRole.organization, Practitioner.practitionerRole.role
... practitionerRole 0..*BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S0..1Reference(QICore-Organization)Organization where the roles are performed
.... role S ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: HSPC ProviderPractitioner Type (preferred)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: HSPC ProviderPractitioner Specialty (preferred)
..... practitioner-primaryInd 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd
..... coding ∑0..*CodingCode defined by a terminology system
..... text ∑0..1stringPlain text representation of the concept
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period S ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(QICore-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)
... practitionerRole 0..*BackboneElementRoles/organizations the practitioner is associated with
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S0..1Reference(QICore-Organization)Organization where the roles are performed
.... role S ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... practitioner-primaryInd 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd
..... coding ∑0..*CodingCode defined by a terminology system
..... text ∑0..1stringPlain text representation of the concept
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period S ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(QICore-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)
... practitionerRole 0..*BackboneElementRoles/organizations the practitioner is associated with
.... hspc-extensionspracticeAffiliationType 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspracticeAffiliationType
Binding: HSPC Practice Affiliation Type (example)
.... hspc-extensionspractitionerPrivilege 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspractitionerPrivilege
Binding: HSPC ProviderPractitioner Privilege (preferred)
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... organization S0..1Reference(QICore-Organization)Organization where the roles are performed
.... role S ∑0..1CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
.... specialty S ∑0..*CodeableConceptSpecific specialty of the practitioner
Binding: PractitionerSpecialty (example)
..... practitioner-primaryInd 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd
..... coding ∑0..*CodingCode defined by a terminology system
..... text ∑0..1stringPlain text representation of the concept
.... identifier ∑0..*IdentifierBusiness Identifiers that are specific to a role/location
.... telecom ∑0..*ContactPointContact details that are specific to the role/location/service
.... period S ∑0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... location 0..*Reference(QICore-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
.... hspc-extensionscredentialEligibilityInd 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscredentialEligibilityInd
Binding: v2 Yes/no Indicator (preferred)
.... 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(QICore-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)
.... hspc-extensionscommunicationMode 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)
.... coding ∑0..*CodingCode defined by a terminology system
.... text ∑0..1stringPlain text representation of the concept

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Practitioner.language?extrequiredhttp://tools.ietf.org/html/bcp47
Practitioner.telecom.systemContactPointSystemrequiredContactPointSystem
Practitioner.telecom.useContactPointUserequiredContactPointUse
Practitioner.address.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator]]		v2 Yes/no Indicatorpreferredv2 Yes/no Indicator
Practitioner.address.useAddressUserequiredAddressUse
Practitioner.address.typeAddressTyperequiredAddressType
Practitioner.genderAdministrativeGenderrequiredAdministrativeGender
Practitioner.practitionerRole.rolePractitionerRoleexamplePractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.practitionerRole.rolePractitionerRoleexamplePractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.practitionerRole.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionspracticeAffiliationType]]		HSPC Practice Affiliation TypeexampleHSPC Practice Affiliation Type
Practitioner.practitionerRole.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionspractitionerPrivilege]]		HSPC ProviderPractitioner PrivilegepreferredHSPC ProviderPractitioner Privilege
Practitioner.practitionerRole.rolePractitionerRoleexamplePractitionerRole
Practitioner.practitionerRole.specialtyPractitionerSpecialtyexamplePractitionerSpecialty
Practitioner.qualification.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionscredentialEligibilityInd]]		v2 Yes/no Indicatorpreferredv2 Yes/no Indicator
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
Practitioner.communication.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode]]		HSPC Communication ModepreferredHSPC Communication Mode

H.??.3 Constraints

IdPathDetailsRequirements
.