Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnectPractitioner1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1 Version: 0.1.0
Draft as of 2018-11-05 Computable Name: CareConnect-Practitioner-1

Copyright/Legal: Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html

The Practitioner resource represents the healthcare professional directly or indirectly involved in the provision of healthcare related services.

CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

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

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... Slices for identifier 0..*IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End by value:system
.... identifier:sdsUserID 0..1IdentifierA identifier for the person as this agent
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID 0..*IdentifierA identifier for the person as this agent
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... qualification
.... identifier
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... issuer 0..1Reference(CareConnect-Organization-1)Organization that regulates and issues the qualification
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Practitioner.genderrequiredAdministrative Gender
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... Slices for identifier Σ0..*IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End by value:system
.... identifier:sdsUserID Σ0..1IdentifierA identifier for the person as this agent
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID Σ0..*IdentifierA identifier for the person as this agent
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... gender Σ0..1codemale | female | other | unknown
Binding: Administrative Gender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.identifier:sdsUserID.userequiredIdentifierUse
Practitioner.identifier:sdsRoleProfileID.userequiredIdentifierUse
Practitioner.genderrequiredAdministrative Gender

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorPractitionerIf 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()
ele-1errorPractitioner.extension:nhsCommunicationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPractitioner.extension:nhsCommunicationMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End by value:system
.... identifier:sdsUserID Σ0..1IdentifierA identifier for the person as this agent
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID Σ0..*IdentifierA identifier for the person as this agent
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... 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)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: Administrative Gender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml: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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service

.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(CareConnect-Organization-1)Organization that regulates and issues the qualification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.identifier:sdsUserID.userequiredIdentifierUse
Practitioner.identifier:sdsUserID.typeextensibleIdentifier Type Codes
Practitioner.identifier:sdsRoleProfileID.userequiredIdentifierUse
Practitioner.identifier:sdsRoleProfileID.typeextensibleIdentifier Type Codes
Practitioner.genderrequiredAdministrative Gender
Practitioner.qualification.identifier.userequiredIdentifierUse
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
Practitioner.qualification.codeexamplev2 table 0360, Version 2.7

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorPractitioner.extension:nhsCommunication, Practitioner.qualificationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPractitioner.extension:nhsCommunicationMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Practitioner

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:system (Open at End)

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... Slices for identifier 0..*IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End by value:system
.... identifier:sdsUserID 0..1IdentifierA identifier for the person as this agent
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID 0..*IdentifierA identifier for the person as this agent
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... qualification
.... identifier
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... issuer 0..1Reference(CareConnect-Organization-1)Organization that regulates and issues the qualification
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Practitioner.genderrequiredAdministrative Gender

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... Slices for identifier Σ0..*IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End by value:system
.... identifier:sdsUserID Σ0..1IdentifierA identifier for the person as this agent
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID Σ0..*IdentifierA identifier for the person as this agent
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... gender Σ0..1codemale | female | other | unknown
Binding: Administrative Gender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.identifier:sdsUserID.userequiredIdentifierUse
Practitioner.identifier:sdsRoleProfileID.userequiredIdentifierUse
Practitioner.genderrequiredAdministrative Gender

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorPractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorPractitionerIf 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()
ele-1errorPractitioner.extension:nhsCommunicationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPractitioner.extension:nhsCommunicationMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*PractitionerA 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
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... nhsCommunication 0..*(Complex)NHS communication preferences for a resource
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierA identifier for the person as this agent
Slice: Unordered, Open At End by value:system
.... identifier:sdsUserID Σ0..1IdentifierA identifier for the person as this agent
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-user-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:sdsRoleProfileID Σ0..*IdentifierA identifier for the person as this agent
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/sds-role-profile-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... 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)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
Binding: Administrative Gender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml: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
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service

.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(CareConnect-Organization-1)Organization that regulates and issues the qualification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.identifier:sdsUserID.userequiredIdentifierUse
Practitioner.identifier:sdsUserID.typeextensibleIdentifier Type Codes
Practitioner.identifier:sdsRoleProfileID.userequiredIdentifierUse
Practitioner.identifier:sdsRoleProfileID.typeextensibleIdentifier Type Codes
Practitioner.genderrequiredAdministrative Gender
Practitioner.qualification.identifier.userequiredIdentifierUse
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
Practitioner.qualification.codeexamplev2 table 0360, Version 2.7

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorPractitioner.extension:nhsCommunication, Practitioner.qualificationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorPractitioner.extension:nhsCommunicationMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Practitioner

Summary

Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Practitioner.identifier is sliced based on the value of value:system (Open at End)

 

Other representations of profile: CSV, Excel, Schematron