Release
4B
5
Ballot
Administration
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
see
ballot
notes
).
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
R3
R2
|
Patient
Administration
Work
Group
|
Maturity Level : 3 | Trial Use | Security Category : Business | Compartments : Not linked to any defined compartments |
A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
This resource may be used in a shared registry of contact and other information for various organizations or it can be used merely as a support for other resources that need to reference organizations, perhaps as a document , message or as a contained resource. If using a registry approach, it's entirely possible for multiple registries to exist, each dealing with different types or levels of organization.
The Organization resource is used for collections of people that have come together to achieve an objective. The Group resource is used to identify a collection of people (or animals, devices, etc.) that are gathered for the purpose of analysis or acting upon, but are not expected to act themselves.
The
Organization
resource
often
exists
as
a
hierarchy
of
organization
resources,
using
the
part-of
property
to
provide
the
association
of
the
child
to
its
parent
organization.
This
organizational
hierarchy
helps
communicate
the
conceptual
structure,
whereas
the
Location
resource
provides
the
physical
representation
of
the
hierarchy.
The
linkage
between
Organization
and
Location
is
from
each
point
in
the
location
hierarchy
to
the
appropriate
level
in
the
Organization
hierarchy.
These
links
don't
all
have
to
be
to
the
top
level
Organization.
When
populating
the
organization
and
location
hierarchies
there
is
often
not
a
clear
distinction
between
these
2,
however
to
assist
in
making
the
decision,
Locations
are
always
used
for
recording
where
a
service
occurs,
and
hence
where
encounters
and
observations
are
associated.
The
Organization
property
on
these
resources
might
not
be
the
location
where
the
service
took
place.
OrganizationAffiliation allows you to specify details about organization affiliations that are more complex than simple partOf relationships, such as organizations that are separate legal entities, or have other non-hierarchical relationships. No ownership is implied via OrganizationAffiliation. A single OrganizationAffiliation represents the details of a single relationship between a single pair of Organizations, including the period during which the relationship is active. Current network members can be discovered by searching for OrganizationAffiliations, and historic data can be retained without overhead and still be accessible when searching.
As noted in the Event pattern, a Location represents where a service is performed. An Organization can represent who performed the service.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
Organization
|
TU | DomainResource |
A
grouping
of
people
or
organizations
with
a
common
purpose
+ Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
identifier
|
Σ
|
0..* | Identifier |
Identifies
this
organization
across
multiple
systems
|
active
|
?! Σ | 0..1 | boolean |
Whether
the
organization's
record
is
still
in
active
use
|
|
type
|
Σ | 0..* | CodeableConcept |
Kind
of
organization
OrganizationType ( Example ) |
|
name
|
Σ
|
0..1 | string |
Name
used
for
the
organization
|
|
alias
|
0..* | string |
A
list
of
alternate
names
that
the
organization
is
known
as,
or
was
known
as
in
the
past
|
|
|
description
|
|
|
|
|
|
|
|
0..* |
|
+ Rule: The telecom of an organization can never be of use 'home' + Rule: |
partOf
|
Σ | 0..1 | Reference ( Organization ) |
The
organization
of
which
this
organization
forms
a
part
|
|
endpoint
|
0..* |
|
|
|
qualification
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Qualification ( Example ) |
|
|
|
0..1 |
|
|
|
|
|
Reference
(
|
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<Organization xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<</identifier><identifier><!-- I 0..* Identifier Identifies this organization across multiple systems --></identifier> <active value="[boolean]"/><!-- 0..1 Whether the organization's record is still in active use --> <type><!-- 0..* CodeableConcept Kind of organization --></type><<name value="[string]"/><!-- I 0..1 Name used for the organization --> <alias value="[string]"/><!-- 0..* A list of alternate names that the organization is known as, or was known as in the past --><</telecom> <</address><description value="[string]"/><!-- 0..1 Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name --> <contact><!-- 0..* ExtendedContactDetail Official contact details for the Organization --></contact> <partOf><!-- 0..1 Reference(Organization) The organization of which this organization forms a part --></partOf>< <</purpose> <</name> <</telecom> <</address> </contact><endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization --></endpoint> <qualification> <!-- 0..* Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care --> <identifier><!-- 0..* Identifier An identifier for this qualification for the organization --></identifier> <code><!-- 1..1 CodeableConcept Coded representation of the qualification --></code> <period><!-- 0..1 Period Period during which the qualification is valid --></period> <issuer><!-- 0..1 Reference(Organization) Organization that regulates and issues the qualification --></issuer> </qualification> </Organization>
JSON Template
{
"resourceType" : "Organization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"identifier" : [{ Identifier }], // I Identifies this organization across multiple systems
"active" : <boolean>, // Whether the organization's record is still in active use
"type" : [{ CodeableConcept }], // Kind of organization
"
"name" : "<string>", // I Name used for the organization
"alias" : ["<string>"], // A list of alternate names that the organization is known as, or was known as in the past
"
"
"description" : "<string>", // Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
"contact" : [{ ExtendedContactDetail }], // Official contact details for the Organization
"partOf" : { Reference(Organization) }, // The organization of which this organization forms a part
"
"
"
"
"
}],
"
"endpoint" : [{ Reference(Endpoint) }], // Technical endpoints providing access to services operated for the organization
"qualification" : [{ // Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care
"identifier" : [{ Identifier }], // An identifier for this qualification for the organization
"code" : { CodeableConcept }, // R! Coded representation of the qualification
"period" : { Period }, // Period during which the qualification is valid
"issuer" : { Reference(Organization) } // Organization that regulates and issues the qualification
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir:fhir:Organization.identifier [ Identifier ], ... ; # 0..* I Identifies this organization across multiple systems fhir:Organization.active [ boolean ]; # 0..1 Whether the organization's record is still in active use fhir:Organization.type [ CodeableConcept ], ... ; # 0..* Kind of organizationfhir:fhir:Organization.name [ string ]; # 0..1 I Name used for the organization fhir:Organization.alias [ string ], ... ; # 0..* A list of alternate names that the organization is known as, or was known as in the pastfhir: fhir:fhir:Organization.description [ string ]; # 0..1 Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name fhir:Organization.contact [ ExtendedContactDetail ], ... ; # 0..* Official contact details for the Organization fhir:Organization.partOf [ Reference(Organization) ]; # 0..1 The organization of which this organization forms a partfhir: fhir: fhir: fhir: fhir: ], ...;fhir:Organization.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for the organization fhir:Organization.qualification [ # 0..* Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care fhir:Organization.qualification.identifier [ Identifier ], ... ; # 0..* An identifier for this qualification for the organization fhir:Organization.qualification.code [ CodeableConcept ]; # 1..1 Coded representation of the qualification fhir:Organization.qualification.period [ Period ]; # 0..1 Period during which the qualification is valid fhir:Organization.qualification.issuer [ Reference(Organization) ]; # 0..1 Organization that regulates and issues the qualification ], ...; ]
Changes since R4
| Organization | |
| Organization.description |
|
| Organization.contact |
|
| Organization.qualification |
|
| Organization.qualification.identifier |
|
| Organization.qualification.code |
|
| Organization.qualification.period |
|
| Organization.qualification.issuer |
|
| Organization.telecom |
|
| Organization.address |
|
| Organization.contact.purpose |
|
| Organization.contact.name |
|
| Organization.contact.telecom |
|
| Organization.contact.address |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
11
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
1
r3
resources
are
invalid
(0
errors).
)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
Organization
|
TU | DomainResource |
A
grouping
of
people
or
organizations
with
a
common
purpose
+ Rule: The organization SHALL at least have a name or an identifier, and possibly more than one Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
identifier
|
Σ
|
0..* | Identifier |
Identifies
this
organization
across
multiple
systems
|
|
active
|
?! Σ | 0..1 | boolean |
Whether
the
organization's
record
is
still
in
active
use
|
|
type
|
Σ | 0..* | CodeableConcept |
Kind
of
organization
OrganizationType ( Example ) |
|
name
|
Σ
|
0..1 | string |
Name
used
for
the
organization
|
|
alias
|
0..* | string |
A
list
of
alternate
names
that
the
organization
is
known
as,
or
was
known
as
in
the
past
|
|
|
description
|
|
|
|
|
|
|
|
0..* |
|
+ Rule: The telecom of an organization can never be of use 'home' + Rule: |
|
partOf
|
Σ | 0..1 | Reference ( Organization ) |
The
organization
of
which
this
organization
forms
a
part
|
|
endpoint
|
0..* |
|
|
|
|
qualification
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Qualification ( Example ) |
|
|
|
0..1 |
|
|
|
|
|
|
Reference
(
|
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<Organization xmlns="http://hl7.org/fhir"><</identifier><identifier><!-- I 0..* Identifier Identifies this organization across multiple systems --></identifier> <active value="[boolean]"/><!-- 0..1 Whether the organization's record is still in active use --> <type><!-- 0..* CodeableConcept Kind of organization --></type><<name value="[string]"/><!-- I 0..1 Name used for the organization --> <alias value="[string]"/><!-- 0..* A list of alternate names that the organization is known as, or was known as in the past --><</telecom> <</address><description value="[string]"/><!-- 0..1 Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name --> <contact><!-- 0..* ExtendedContactDetail Official contact details for the Organization --></contact> <partOf><!-- 0..1 Reference(Organization) The organization of which this organization forms a part --></partOf>< <</purpose> <</name> <</telecom> <</address> </contact><endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization --></endpoint> <qualification> <!-- 0..* Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care --> <identifier><!-- 0..* Identifier An identifier for this qualification for the organization --></identifier> <code><!-- 1..1 CodeableConcept Coded representation of the qualification --></code> <period><!-- 0..1 Period Period during which the qualification is valid --></period> <issuer><!-- 0..1 Reference(Organization) Organization that regulates and issues the qualification --></issuer> </qualification> </Organization>
JSON Template
{
"resourceType" : "Organization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"identifier" : [{ Identifier }], // I Identifies this organization across multiple systems
"active" : <boolean>, // Whether the organization's record is still in active use
"type" : [{ CodeableConcept }], // Kind of organization
"
"name" : "<string>", // I Name used for the organization
"alias" : ["<string>"], // A list of alternate names that the organization is known as, or was known as in the past
"
"
"description" : "<string>", // Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
"contact" : [{ ExtendedContactDetail }], // Official contact details for the Organization
"partOf" : { Reference(Organization) }, // The organization of which this organization forms a part
"
"
"
"
"
}],
"
"endpoint" : [{ Reference(Endpoint) }], // Technical endpoints providing access to services operated for the organization
"qualification" : [{ // Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care
"identifier" : [{ Identifier }], // An identifier for this qualification for the organization
"code" : { CodeableConcept }, // R! Coded representation of the qualification
"period" : { Period }, // Period during which the qualification is valid
"issuer" : { Reference(Organization) } // Organization that regulates and issues the qualification
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir:fhir:Organization.identifier [ Identifier ], ... ; # 0..* I Identifies this organization across multiple systems fhir:Organization.active [ boolean ]; # 0..1 Whether the organization's record is still in active use fhir:Organization.type [ CodeableConcept ], ... ; # 0..* Kind of organizationfhir:fhir:Organization.name [ string ]; # 0..1 I Name used for the organization fhir:Organization.alias [ string ], ... ; # 0..* A list of alternate names that the organization is known as, or was known as in the pastfhir: fhir:fhir:Organization.description [ string ]; # 0..1 Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name fhir:Organization.contact [ ExtendedContactDetail ], ... ; # 0..* Official contact details for the Organization fhir:Organization.partOf [ Reference(Organization) ]; # 0..1 The organization of which this organization forms a partfhir: fhir: fhir: fhir: fhir: ], ...;fhir:Organization.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for the organization fhir:Organization.qualification [ # 0..* Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care fhir:Organization.qualification.identifier [ Identifier ], ... ; # 0..* An identifier for this qualification for the organization fhir:Organization.qualification.code [ CodeableConcept ]; # 1..1 Coded representation of the qualification fhir:Organization.qualification.period [ Period ]; # 0..1 Period during which the qualification is valid fhir:Organization.qualification.issuer [ Reference(Organization) ]; # 0..1 Organization that regulates and issues the qualification ], ...; ]
Changes since Release 4
| Organization | |
| Organization.description |
|
| Organization.contact |
|
| Organization.qualification |
|
| Organization.qualification.identifier |
|
| Organization.qualification.code |
|
| Organization.qualification.period |
|
| Organization.qualification.issuer |
|
| Organization.telecom |
|
| Organization.address |
|
| Organization.contact.purpose |
|
| Organization.contact.name |
|
| Organization.contact.telecom |
|
| Organization.contact.address |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Conversions
between
R3
and
R4
See
R3
<-->
R4
Conversion
Maps
(status
=
11
tests
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
1
r3
resources
are
invalid
(0
errors).
)
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Organization.type |
This example value set defines a set of codes that can be used to indicate a type of organization. |
Example | OrganizationType |
| Organization.qualification.code |
|
|
|
|
Level | Location | Description | Expression |
org-1
|
Rule | (base) | The organization SHALL at least have a name or an identifier, and possibly more than one | (identifier.count() + name.count()) > 0 |
|
org-3
|
Rule |
|
|
|
|
org-4
|
Rule |
|
The
|
|
An
example
organization
hierarchy
should
help
give
some
guidance
as
to
one
example
of
how
a
location
hierarchy
could
look
within
a
fictitious
Medical
Organization.
(The
nesting
here
would
be
the
"part-of"
structure
of
the
Organization
resource)
Burgers University Medical Center
Eastern Services (prov)
Emergency Dept
Oncology Dept
Nuclear Medicine Research Trials (edu)
Maternity Ward
Childrens Ward
Day Procedures Unit
Mobile Services (Ambulance)
Research Center (edu)
Nuclear Medicine (edu)
Burgers University (edu)
Nuclear Medicine Faculty (edu)
Undergraduate Medicine (edu)
...
Note that physical structures of this hierarchy are not present - these are defined by a Location hierarchy.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| active N | token | Is the Organization record active | Organization.active | |
| address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
|
|
| address-city N | string | A city specified in an address |
|
|
| address-country N | string | A country specified in an address |
|
|
| address-postalcode N | string | A postal code specified in an address |
|
|
| address-state N | string | A state specified in an address |
|
|
| address-use N | token | A use code specified in an address |
|
|
| endpoint | reference | Technical endpoints providing access to services operated for the organization |
Organization.endpoint
( Endpoint ) |
|
| identifier | token | Any identifier for the organization (not the accreditation issuer's identifier) | Organization.identifier | Organization.qualification.identifier | |
| name | string | A portion of the organization's name or alias | Organization.name | Organization.alias | |
| partof | reference | An organization of which this organization forms a part |
Organization.partOf
( Organization ) |
|
| phonetic N | string | A portion of the organization's name using some kind of phonetic matching algorithm | Organization.name | |
| type | token | A code for the type of organization | Organization.type |
FHIR
®©
HL7.org
2011+.
FHIR
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Sat,
May
28,
Sep
10,
2022
12:56+1000.
05:05+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change