Administration
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
(v3.3.0:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
Ballot
2).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Content
Examples
Detailed
Descriptions
Mappings
Profiles
&
Extensions
|
Patient
Administration
Work
Group
|
Maturity
Level
:
|
|
Compartments
:
|
This
resource
did
not
exist
in
Release
2
This
analysis
is
available
as
XML
or
JSON
.
Structure
Name
Flags
Card.
Type
Description
&
Constraints
VerificationResult
TU
DomainResource
Describes
validation
requirements,
source(s),
status
and
dates
for
one
or
more
elements
Elements
defined
in
Ancestors:
id
,
meta
,
implicitRules
,
language
,
text
,
contained
,
extension
,
modifierExtension
target
Σ
0..*
Reference
(
Any
)
A
resource
that
was
validated
targetLocation
Σ
0..*
string
The
fhirpath
location(s)
within
the
resource
that
was
validated
need
Σ
0..1
CodeableConcept
none
|
initial
|
periodic
Need
(
Preferred
)
status
Σ
1..1
code
attested
|
validated
|
in-process
|
req-revalid
|
val-fail
|
reval-fail
Status
(
Required
)
statusDate
Σ
0..1
dateTime
When
the
validation
status
was
updated
validationType
Σ
0..1
CodeableConcept
nothing
|
primary
|
multiple
Validation-type
(
Preferred
)
validationProcess
Σ
0..*
CodeableConcept
The
primary
process
by
which
the
target
is
validated
(edit
check;
value
set;
primary
source;
multiple
sources;
standalone;
in
context)
Validation-process
(
Example
)
frequency
0..1
Timing
Frequency
of
revalidation
lastPerformed
0..1
dateTime
The
date/time
validation
was
last
completed
(including
failed
validations)
nextScheduled
0..1
date
The
date
when
target
is
next
validated,
if
appropriate
failureAction
Σ
0..1
CodeableConcept
fatal
|
warn
|
rec-only
|
none
Failure-action
(
Preferred
)
primarySource
0..*
BackboneElement
Information
about
the
primary
source(s)
involved
in
validation
who
0..1
Reference
(
Organization
|
Practitioner
|
PractitionerRole
)
Reference
to
the
primary
source
type
Σ
0..*
CodeableConcept
Type
of
primary
source
(License
Board;
Primary
Education;
Continuing
Education;
Postal
Service;
Relationship
owner;
Registration
Authority;
legal
source;
issuing
source;
authoritative
source)
Primary-source-type
(
Example
)
communicationMethod
Σ
0..*
CodeableConcept
Method
for
exchanging
information
with
the
primary
source
VerificationResult
Communication
Method
(
Example
)
validationStatus
0..1
CodeableConcept
successful
|
failed
|
unknown
Validation-status
(
Preferred
)
validationDate
0..1
dateTime
When
the
target
was
validated
against
the
primary
source
canPushUpdates
Σ
0..1
CodeableConcept
yes
|
no
|
undetermined
Can-push-updates
(
Preferred
)
pushTypeAvailable
0..*
CodeableConcept
specific
|
any
|
source
Push-type-available
(
Preferred
)
attestation
0..1
BackboneElement
Information
about
the
entity
attesting
to
information
who
Σ
0..1
Reference
(
Practitioner
|
PractitionerRole
|
Organization
)
The
individual
or
organization
attesting
to
information
onBehalfOf
Σ
0..1
Reference
(
Organization
|
Practitioner
|
PractitionerRole
)
When
the
who
is
asserting
on
behalf
of
another
(organization
or
individual)
communicationMethod
Σ
0..1
CodeableConcept
The
method
by
which
attested
information
was
submitted/retrieved
VerificationResult
Communication
Method
(
Example
)
date
Σ
0..1
date
The
date
the
information
was
attested
to
sourceIdentityCertificate
0..1
string
A
digital
identity
certificate
associated
with
the
attestation
source
proxyIdentityCertificate
0..1
string
A
digital
identity
certificate
associated
with
the
proxy
entity
submitting
attested
information
on
behalf
a
representation
of
the
attestation
source
proxySignature
0..1
Signature
Proxy
signature
sourceSignature
0..1
Signature
Attester
signature
validator
0..*
BackboneElement
Information
about
the
entity
validating
information
organization
1..1
Reference
(
Organization
)
Reference
to
the
organization
validating
information
identityCertificate
0..1
string
A
digital
identity
certificate
associated
with
the
validator
attestationSignature
0..1
Signature
Validator
signature
Documentation
json
schema
for
this
format
UML
Diagram
(
Legend
)
VerificationResult
(
DomainResource
)
A
resource
that
was
validated
target
:
Reference
[0..*]
«
Any
»
The
fhirpath
location(s)
within
the
resource
that
was
validated
targetLocation
:
string
[0..*]
The
frequency
with
which
the
target
must
be
validated
(none;
initial;
periodic)
need
:
CodeableConcept
[0..1]
«
The
frequency
with
which
the
target
must
be
validated.
(Strength=Preferred)
need
?
»
The
validation
status
of
the
target
(attested;
validated;
in
process;
requires
revalidation;
validation
failed;
revalidation
failed)
status
:
code
[1..1]
«
The
validation
status
of
the
target.
(Strength=Required)
status
!
»
When
the
validation
status
was
updated
statusDate
:
dateTime
[0..1]
What
the
target
is
validated
against
(nothing;
primary
source;
multiple
sources)
validationType
:
CodeableConcept
[0..1]
«
What
the
target
is
validated
against.
(Strength=Preferred)
validation-type
?
»
The
primary
process
by
which
the
target
is
validated
(edit
check;
value
set;
primary
source;
multiple
sources;
standalone;
in
context)
validationProcess
:
CodeableConcept
[0..*]
«
The
primary
process
by
Practitioner,
which
the
target
is
validated.
(Strength=Example)
validation-process
??
»
Frequency
of
revalidation
frequency
:
Timing
[0..1]
The
date/time
validation
was
last
completed
(including
failed
validations)
lastPerformed
:
dateTime
[0..1]
The
date
when
target
is
next
validated,
if
appropriate
nextScheduled
:
date
[0..1]
The
result
if
validation
fails
(fatal;
warning;
record
only;
none)
failureAction
:
CodeableConcept
[0..1]
«
The
result
if
validation
fails.
(Strength=Preferred)
failure-action
?
»
PrimarySource
Reference
to
the
primary
source
who
:
Reference
[0..1]
«
Organization
|
Practitioner
|
PractitionerRole
»
Type
of
primary
source
(License
Board;
Primary
Education;
Continuing
Education;
Postal
Service;
Relationship
owner;
Registration
Authority;
legal
source;
issuing
source;
authoritative
source)
type
:
CodeableConcept
[0..*]
«
Type
of
the
validation
primary
source.
(Strength=Example)
primary-source-type
??
»
Method
for
communicating
with
the
primary
source
(manual;
API;
Push)
communicationMethod
:
CodeableConcept
[0..*]
«
Method
for
communicating
with
the
data
source
(manual;
API;
Push).
(Strength=Example)
verificationresult-communicat...
??
»
Status
of
the
validation
of
the
target
against
the
primary
source
(successful;
failed;
unknown)
validationStatus
:
CodeableConcept
[0..1]
«
Status
of
the
validation
of
the
target
against
the
primary
source.
(Strength=Preferred)
validation-status
?
»
When
the
target
was
validated
against
the
primary
source
validationDate
:
dateTime
[0..1]
Ability
of
the
primary
source
to
push
updates/alerts
(yes;
no;
undetermined)
canPushUpdates
:
CodeableConcept
[0..1]
«
Ability
of
the
primary
source
to
push
updates/alerts.
(Strength=Preferred)
can-push-updates
?
»
Type
of
alerts/updates
the
primary
source
can
send
(specific
requested
changes;
any
changes;
as
defined
by
source)
pushTypeAvailable
:
CodeableConcept
[0..*]
«
Type
of
alerts/updates
the
primary
source
can
send.
(Strength=Preferred)
push-type-available
?
»
Attestation
The
individual
or
organization
attesting
to
information
who
:
Reference
[0..1]
«
Practitioner
|
PractitionerRole
|
Organization
»
When
the
who
is
asserting
on
behalf
of
another
(organization
or
individual)
onBehalfOf
:
Reference
[0..1]
«
Organization
|
Practitioner
|
PractitionerRole
»
The
method
by
which
attested
information
was
submitted/retrieved
(manual;
API;
Push)
communicationMethod
:
CodeableConcept
[0..1]
«
Method
for
communicating
with
the
data
source
(manual;
API;
Push).
(Strength=Example)
verificationresult-communicat...
??
»
The
date
the
information
was
attested
to
date
:
date
[0..1]
A
digital
identity
certificate
associated
with
the
attestation
source
sourceIdentityCertificate
:
string
[0..1]
A
digital
identity
certificate
associated
with
the
proxy
entity
submitting
attested
information
on
behalf
of
the
attestation
source
proxyIdentityCertificate
:
string
[0..1]
Signed
assertion
by
the
proxy
entity
indicating
that
they
have
the
right
to
submit
attested
information
on
behalf
just
a
part
of
the
attestation
source
proxySignature
:
Signature
[0..1]
Signed
assertion
by
the
attestation
source
that
they
have
attested
to
the
information
sourceSignature
:
Signature
[0..1]
Validator
Reference
to
the
organization
validating
information
organization
:
Reference
[1..1]
«
Organization
»
A
digital
identity
certificate
associated
with
the
validator
identityCertificate
:
string
[0..1]
Signed
assertion
by
the
validator
that
they
have
validated
the
information
attestationSignature
:
Signature
[0..1]
Information
about
the
primary
source(s)
involved
in
validation
primarySource
[0..*]
Information
about
the
entity
attesting
to
information
attestation
[0..1]
Information
about
the
entity
validating
information
validator
[0..*]
XML
Template
<
<!-- from -->
<!-- from -->
<</target>
<
<</need>
<
<
<</validationType>
<</validationProcess>
<</frequency>
<
<
<</failureAction>
<
<</who>
<</type>
<</communicationMethod>
<</validationStatus>
<
<</canPushUpdates>
<</pushTypeAvailable>
</primarySource>
<
<</who>
<</onBehalfOf>
<</communicationMethod>
<
<
<
<</proxySignature>
<</sourceSignature>
</attestation>
<
<</organization>
<
<</attestationSignature>
</validator>
</VerificationResult>
full
JSON
Template
Schema
.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/Practitioner",
"$ref": "#/definitions/Practitioner",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"Practitioner": {
"description": "A person who is directly or indirectly involved in the provisioning of healthcare.",
"properties": {
"resourceType": {
"description": "This is a Practitioner resource",
"const": "Practitioner"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. 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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "An identifier that applies to this person in this role.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"active": {
"description": "Whether this practitioner\u0027s record is in active use.",
"$ref": "#/definitions/boolean"
},
"_active": {
"description": "Extensions for active",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "The name(s) associated with the practitioner.",
"items": {
"$ref": "HumanName.schema.json#/definitions/HumanName"
},
"type": "array"
},
"telecom": {
"description": "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"items": {
"$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
},
"type": "array"
},
"address": {
"description": "Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.",
"items": {
"$ref": "Address.schema.json#/definitions/Address"
},
"type": "array"
},
"gender": {
"description": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"enum": [
"male",
"female",
"other",
"unknown"
]
},
"_gender": {
"description": "Extensions for gender",
"$ref": "Element.schema.json#/definitions/Element"
},
"birthDate": {
"description": "The date of birth for the practitioner.",
"$ref": "#/definitions/date"
},
"_birthDate": {
"description": "Extensions for birthDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"photo": {
"description": "Image of the person.",
"items": {
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"type": "array"
},
"qualification": {
"description": "Qualifications obtained by training and certification.",
"items": {
"$ref": "#/definitions/Practitioner_Qualification"
},
"type": "array"
},
"communication": {
"description": "A language the practitioner can use in patient communication.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Practitioner_Qualification": {
"description": "A person who is directly or indirectly involved in the provisioning of healthcare.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "An identifier that applies to this person\u0027s qualification in this role.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"code": {
"description": "Coded representation of the qualification.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"period": {
"description": "Period during which the qualification is valid.",
"$ref": "Period.schema.json#/definitions/Period"
},
"issuer": {
"description": "Organization that regulates and issues the qualification.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"additionalProperties": false,
"required": [
"code"
]
}
}
}
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
Mixed
Nomative/Trial
Use
Ballot
(v3.3.0-13671)
generated
on
Fri,
Nov
1,
2019
09:37+1100.
Tue,
Apr
3,
2018
12:17+1000.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
R3
DSTU3
|
|
Propose
a
change