pca-practitioner-personal-contact-details
type: StructureDefinition
node role: treeRoot
id:
  v: pca-practitioner-personal-contact-details
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition pca-practitioner-personal-contact-details Name Flags Card. Type Description & Constraints ContactPoint 0..* ContactPoint Details of a Technology mediated contact point (phone, email, etc.) system S 1..1 code phone | email Binding: PCA Restricted Contact Point System (required) value S 1..1 string The actual contact point details use S 1..1 code home Fixed Value: home Documentation for this format
url:
  v: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-practitioner-personal-contact-details
version:
  v: 24.2.0.0
name:
  v: PractitionerPersonalContactDetails
title:
  v: Practitioner Personal Contact Details
status:
  v: active
date:
  v: 2024-09-23T10:57:22+10:00
publisher:
  v: Australian Digital Health Agency
contact:
  telecom:
    system:
      v: email
description:
  v: This Contact Point data type profile enables sharing personal contact information (i.e. personal telephone and email address) of a practitioner, with their business partners, so that they can be contacted using those channels where appropriate.
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: AU
copyright:
  v: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: servd
  uri:
    v: http://www.omg.org/spec/ServD/1.0/
  name:
    v: ServD
kind:
  v: complex-type
abstract:
  v: false
type:
  v: ContactPoint
base definition:
  v: http://hl7.org/fhir/StructureDefinition/ContactPoint
  link: http://hl7.org/fhir/StructureDefinition/ContactPoint
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: ContactPoint
    path:
      v: ContactPoint
    short:
      v: Details of a Technology mediated contact point (phone, email, etc.)
    definition:
      v: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: ContactPoint
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: cpt-2
      severity:
        v: error
      human:
        v: A system is required if a value is provided.
      expression:
        v: value.empty() or system.exists()
      xpath:
        v: not(exists(f:value)) or exists(f:system)
      source:
        v: http://hl7.org/fhir/StructureDefinition/ContactPoint
        link: http://hl7.org/fhir/StructureDefinition/ContactPoint
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: v2
      map:
        v: XTN
    mapping:
      identity:
        v: rim
      map:
        v: TEL
    mapping:
      identity:
        v: servd
      map:
        v: ContactPoint
  element:
    id:
      v: ContactPoint.id
    path:
      v: ContactPoint.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: http://hl7.org/fhirpath/System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: ContactPoint.extension
    path:
      v: ContactPoint.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Additional content defined by implementations
    definition:
      v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
    comment:
      v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
    alias:
      v: extensions
    alias:
      v: user content
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Element.extension

v: string

v: value

v: url

v: 0

v: *

code:
  v: Extension

key:
  v: ele-1
severity:
  v: error
human:
  v: All FHIR elements must have a @value or children
expression:
  v: hasValue() or (children().count() > id.count())
xpath:
  v: @value|f:*|h:div
source:
  v: http://hl7.org/fhir/StructureDefinition/Element
  link: http://hl7.org/fhir/StructureDefinition/Element

key:
  v: ext-1
severity:
  v: error
human:
  v: Must have either extensions or value[x], not both
expression:
  v: extension.exists() != value.exists()
xpath:
  v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
source:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: ContactPoint.system
path:
  v: ContactPoint.system
short:
  v: phone | email
definition:
  v: Telecommunications form for contact point - what communications system is required to make use of the contact.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ContactPoint.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: cpt-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-restricted-contact-point-system
    link: http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-restricted-contact-point-system
mapping:
  identity:
    v: v2
  map:
    v: XTN.3
mapping:
  identity:
    v: rim
  map:
    v: ./scheme
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointType

id:
  v: ContactPoint.value
path:
  v: ContactPoint.value
short:
  v: The actual contact point details
definition:
  v: The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
comment:
  v: Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
requirements:
  v: Need to support legacy numbers that are not in a tightly controlled format.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ContactPoint.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XTN.1 (or XTN.12)
mapping:
  identity:
    v: rim
  map:
    v: ./url
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: ContactPoint.use
path:
  v: ContactPoint.use
short:
  v: home
definition:
  v: Identifies the purpose for the contact point.
comment:
  v: Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
requirements:
  v: Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ContactPoint.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
fixed:
  v: home
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: ContactPointUse
  strength:
    v: required
  description:
    v: Use of contact point.
  value set:
    v: http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: XTN.2 - but often indicated by field
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPointPurpose

id:
  v: ContactPoint.rank
path:
  v: ContactPoint.rank
short:
  v: Specify preferred order of use (1 = highest)
definition:
  v: Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
comment:
  v: Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.rank
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: positiveInt
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: ContactPoint.period
path:
  v: ContactPoint.period
short:
  v: Time period when the contact point was/is in use
definition:
  v: Time period when the contact point was/is in use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ContactPoint.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

element:
  id:
    v: ContactPoint
  path:
    v: ContactPoint
  short:
    v: Details of a Technology mediated contact point (phone, email, etc.)
element:
  id:
    v: ContactPoint.system
  path:
    v: ContactPoint.system
  short:
    v: phone | email
  min:
    v: 1
  max:
    v: 1
  must support:
    v: true
  binding:
    strength:
      v: required
    value set:
      v: http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-restricted-contact-point-system
      link: http://pca.digitalhealth.gov.au/fhir/4.0/ValueSet/pca-restricted-contact-point-system
element:
  id:
    v: ContactPoint.value
  path:
    v: ContactPoint.value
  min:
    v: 1
  max:
    v: 1
  must support:
    v: true
element:
  id:
    v: ContactPoint.use
  path:
    v: ContactPoint.use
  short:
    v: home
  min:
    v: 1
  max:
    v: 1
  fixed:
    v: home
  must support:
    v: true