FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: cpg-practitioner

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-practitioner

Profile of Practitioner for use with CPG Implementation Guide

This profile builds on Practitioner.

This profile was published on Thu Jun 20 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 19 elements
Must-Support: 21 elements
Fixed Value: 5 elements

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:use
  • The element Practitioner.name is sliced based on the value of value:use
  • The element Practitioner.telecom is sliced based on the value of value:use
  • The element Practitioner.address is sliced based on the value of value:use
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*
... identifier S(Slice Definition)Slice: Unordered, Open by value:use
.... officialIdentifier S1..1Identifier
..... use S1..1codeFixed Value: official
..... value S1..1string
... name S(Slice Definition)Slice: Unordered, Open by value:use
.... officialName S1..1HumanName
..... use S1..1codeFixed Value: official
..... family S1..1stringLast Name
..... given S1..1stringFirst Name
... telecom S(Slice Definition)Slice: Unordered, Open by value:use
.... mobilePhone S1..1ContactPointMobile Phone Number
..... system S1..1codeFixed Value: phone
..... value S1..1string
..... use S1..1codeFixed Value: mobile
... address S(Slice Definition)Slice: Unordered, Open by value:use
.... homeAddress S1..1Address
..... use S1..1codeHome Address
Fixed Value: home
..... text S1..1string
... gender S1..1code
... birthDate S0..1date
... photo S0..*Attachment

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..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Σ(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:use
.... officialIdentifier SΣ1..1IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General': 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Σ(Slice Definition)The name(s) associated with the practitioner
Slice: Unordered, Open by value:use
.... officialName SΣ1..1HumanNameThe name(s) associated with the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family SΣ1..1stringLast Name
..... given SΣ1..1stringFirst Name
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom SΣ(Slice Definition)A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:use
.... mobilePhone SΣ1..1ContactPointMobile Phone Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... 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)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SΣ(Slice Definition)Address(es) of the practitioner that are not role specific (typically home address)
Slice: Unordered, Open by value:use
.... homeAddress SΣ1..1AddressAddress(es) of the practitioner that are not role specific (typically home address)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ1..1codeHome Address
Binding: AddressUse (required)
Fixed Value: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
..... text SΣ1..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
..... city Σ0..1stringName of city, town etc.
Example General': Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General': Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General': 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (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 can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format

Summary

Mandatory: 19 elements
Must-Support: 21 elements
Fixed Value: 5 elements

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:use
  • The element Practitioner.name is sliced based on the value of value:use
  • The element Practitioner.telecom is sliced based on the value of value:use
  • The element Practitioner.address is sliced based on the value of value:use

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*
... identifier S(Slice Definition)Slice: Unordered, Open by value:use
.... officialIdentifier S1..1Identifier
..... use S1..1codeFixed Value: official
..... value S1..1string
... name S(Slice Definition)Slice: Unordered, Open by value:use
.... officialName S1..1HumanName
..... use S1..1codeFixed Value: official
..... family S1..1stringLast Name
..... given S1..1stringFirst Name
... telecom S(Slice Definition)Slice: Unordered, Open by value:use
.... mobilePhone S1..1ContactPointMobile Phone Number
..... system S1..1codeFixed Value: phone
..... value S1..1string
..... use S1..1codeFixed Value: mobile
... address S(Slice Definition)Slice: Unordered, Open by value:use
.... homeAddress S1..1Address
..... use S1..1codeHome Address
Fixed Value: home
..... text S1..1string
... gender S1..1code
... birthDate S0..1date
... photo S0..*Attachment

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..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Σ(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:use
.... officialIdentifier SΣ1..1IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
Fixed Value: official
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General': 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Σ(Slice Definition)The name(s) associated with the practitioner
Slice: Unordered, Open by value:use
.... officialName SΣ1..1HumanNameThe name(s) associated with the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
Fixed Value: official
..... text Σ0..1stringText representation of the full name
..... family SΣ1..1stringLast Name
..... given SΣ1..1stringFirst Name
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
... telecom SΣ(Slice Definition)A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:use
.... mobilePhone SΣ1..1ContactPointMobile Phone Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
Fixed Value: phone
..... value SΣ1..1stringThe actual contact point details
..... 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)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... address SΣ(Slice Definition)Address(es) of the practitioner that are not role specific (typically home address)
Slice: Unordered, Open by value:use
.... homeAddress SΣ1..1AddressAddress(es) of the practitioner that are not role specific (typically home address)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!SΣ1..1codeHome Address
Binding: AddressUse (required)
Fixed Value: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
..... text SΣ1..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
..... city Σ0..1stringName of city, town etc.
Example General': Erewhon
..... district Σ0..1stringDistrict name (aka county)
Example General': Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
..... postalCode Σ0..1stringPostal code for area
Example General': 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
..... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (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 can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet / Code
Practitioner.languagepreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.identifier:officialIdentifier.userequiredFixed Value: official
Practitioner.identifier:officialIdentifier.typeextensibleIdentifier Type Codes
Practitioner.name:officialName.userequiredFixed Value: official
Practitioner.telecom:mobilePhone.systemrequiredFixed Value: phone
Practitioner.telecom:mobilePhone.userequiredFixed Value: mobile
Practitioner.address:homeAddress.userequiredFixed Value: home
Practitioner.address:homeAddress.typerequiredAddressType
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codeexamplev2.0360.2.7
Practitioner.communicationpreferredCommonLanguages
Max Binding: AllLanguages

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2PractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4PractitionerIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3PractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6PractitionerA resource should have narrative for robust management
: text.div.exists()
dom-5PractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1Practitioner.qualificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())