|
ImplementationGuide
|
|
Definition
|
A
set
of
rules
or
how
FHIR
is
used
to
solve
a
particular
problem.
This
resource
is
used
to
gather
all
the
parts
of
an
implementation
guide
into
a
logical
whole,
and
to
publish
a
computable
definition
of
all
the
parts.
A set of rules or how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole, and to publish a computable definition of all the parts.
|
|
Control
|
1..1
|
|
Requirements
|
An
implementation
guide
is
able
to
define
default
profiles
that
must
apply
to
any
use
of
a
resource,
so
validation
services
may
need
to
take
one
or
more
implementation
guide
resources
when
validating.
An implementation guide is able to define default profiles that must apply to any use of a resource, so validation services may need to take one or more implementation guide resources when validating.
|
|
ImplementationGuide.url
|
|
Definition
|
An
absolute
URL
that
is
used
to
identify
this
implementation
guide
when
it
is
referenced
in
a
specification,
model,
design
or
an
instance.
This
SHALL
be
a
URL,
SHOULD
be
globally
unique,
and
SHOULD
be
an
address
at
which
this
implementation
guide
is
(or
will
be)
published.
An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published.
|
|
Control
|
1..1
|
|
Type
|
uri
|
|
Requirements
|
This
is
required
to
allow
hosting
Implementation
Guides
on
multiple
different
servers,
and
to
allow
for
the
editorial
process.
This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process.
|
Alternate
Names
Alternate Names
|
url;
authoritative-url;
destination;
identity
url; authoritative-url; destination; identity
|
|
Summary
|
true
|
|
ImplementationGuide.version
|
|
Definition
|
The
identifier
that
is
used
to
identify
this
version
of
the
Implementation
Guide
when
it
is
referenced
in
a
specification,
model,
design
or
instance.
This
is
an
arbitrary
value
managed
by
the
Implementation
Guide
author
manually.
The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually.
|
|
Note
|
This
is
a
business
versionId,
not
a
resource
identifier
(see
This is a business versionId, not a resource version id (see
discussion
)
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Requirements
|
There
may
be
multiple
resource
versions
of
the
Implementation
Guide
that
have
this
same
identifier.
The
resource
version
id
will
change
for
technical
reasons,
whereas
the
stated
version
number
needs
to
be
under
the
author's
control.
There may be multiple resource versions of the Implementation Guide that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.
|
|
Summary
|
true
|
|
ImplementationGuide.name
|
|
Definition
|
A
free
text
natural
language
name
identifying
the
Implementation
Guide.
A free text natural language name identifying the Implementation Guide.
|
|
Control
|
1..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
Comments
|
Not
expected
to
be
globally
unique.
Not expected to be globally unique.
|
|
ImplementationGuide.status
|
|
Definition
|
The
status
of
the
Implementation
Guide.
The status of the Implementation Guide.
|
|
Control
|
1..1
|
|
Binding
|
ConformanceResourceStatus:
The
lifecycle
status
of
a
Value
Set
or
Concept
Map.
(
ConformanceResourceStatus:
The lifecycle status of a Value Set or Concept Map.
(
Required
)
|
|
Type
|
code
|
Is
Modifier
Is Modifier
|
true
|
|
Requirements
|
Allows
filtering
of
Implementation
Guides
that
are
appropriate
for
use
vs.
not.
Allows filtering of Implementation Guides that are appropriate for use vs. not.
|
|
Summary
|
true
|
|
ImplementationGuide.experimental
|
|
Definition
|
This
Implementation
Guide
was
authored
for
testing
purposes
(or
education/evaluation/marketing),
and
is
not
intended
to
be
used
for
genuine
usage.
This Implementation Guide was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
|
|
Control
|
0..1
|
|
Type
|
boolean
|
|
Requirements
|
Allows
filtering
of
Implementation
Guides
that
are
appropriate
for
use
vs.
not.
Allows filtering of Implementation Guides that are appropriate for use vs. not.
|
|
Summary
|
true
|
|
ImplementationGuide.publisher
|
|
Definition
|
The
name
of
the
individual
or
organization
that
published
the
implementation
guide.
The name of the individual or organization that published the implementation guide.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Requirements
|
Helps
establish
the
"authority/credibility"
of
the
implementation
guide.
May
also
allow
for
contact.
Helps establish the "authority/credibility" of the implementation guide. May also allow for contact.
|
|
Summary
|
true
|
|
Comments
|
Usually
an
organization,
but
may
be
an
individual.
This
item
SHOULD
be
populated
unless
the
information
is
available
from
context.
Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
|
|
ImplementationGuide.contact
|
|
Definition
|
Contacts
to
assist
a
user
in
finding
and
communicating
with
the
publisher.
Contacts to assist a user in finding and communicating with the publisher.
|
|
Control
|
0..*
|
|
Summary
|
true
|
|
Comments
|
May
be
a
web
site,
an
email
address,
a
telephone
number
(tel:),
etc.
May be a web site, an email address, a telephone number (tel:), etc.
|
|
ImplementationGuide.contact.name
|
|
Definition
|
The
name
of
an
individual
to
contact
regarding
the
implementation
guide.
The name of an individual to contact regarding the implementation guide.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
Comments
|
If
there
is
no
named
individual,
the
telecom
is
for
the
organization
as
a
whole.
If there is no named individual, the telecom is for the organization as a whole.
|
|
ImplementationGuide.contact.telecom
|
|
Definition
|
Contact
details
for
individual
(if
a
name
was
provided)
or
the
publisher.
Contact details for individual (if a name was provided) or the publisher.
|
|
Control
|
0..*
|
|
Type
|
ContactPoint
|
|
Summary
|
true
|
|
ImplementationGuide.date
|
|
Definition
|
The
date
this
version
of
the
implementation
guide
was
published.
The
date
must
change
when
the
business
version
changes,
if
it
does,
and
it
must
change
if
the
status
code
changes.
In
addition,
it
should
change
when
the
substantive
content
of
the
implementation
guide
changes.
The date this version of the implementation guide was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
|
|
Control
|
0..1
|
|
Type
|
dateTime
|
|
Summary
|
true
|
|
Comments
|
Additional
specific
dates
may
be
added
as
extensions.
Additional specific dates may be added as extensions.
|
|
ImplementationGuide.description
|
|
Definition
|
A
free
text
natural
language
description
of
the
Implementation
Guide
and
its
use.
A free text natural language description of the Implementation Guide and its use.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
Comments
|
This
field
can
be
used
for
things
such
as
why
the
Implementation
Guide
was
written,
comments
about
misuse,
instructions
for
clinical
use
and
interpretation,
literature
references,
examples
from
the
paper
world,
etc.
It
is
This field can be used for things such as why the Implementation Guide was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is
not
a
rendering
of
the
Implementation
Guide
as
conveyed
in
Implementation
Guide.text.
This
item
SHOULD
be
populated
unless
the
information
is
available
from
context.
a rendering of the Implementation Guide as conveyed in Implementation Guide.text. This item SHOULD be populated unless the information is available from context.
|
|
ImplementationGuide.useContext
|
|
Definition
|
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
terms
may
be
used
to
assist
with
indexing
and
searching
of
implementation
guides.
The
most
common
use
of
this
element
is
to
represent
the
country
/
jurisdiction
for
which
this
implementation
guide
was
defined.
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of implementation guides. The most common use of this element is to represent the country / jurisdiction for which this implementation guide was defined.
|
|
Control
|
0..*
|
|
Binding
|
Context
of
Use
ValueSet:
Indicates
the
countries,
regions,
disciplines
and
other
aspects
of
use
within
which
this
artifact
is
targeted
for
use.
(
Context of Use ValueSet:
Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.
(
Extensible
)
|
|
Type
|
CodeableConcept
|
|
Requirements
|
Assist
in
searching
for
appropriate
implementation
guide.
Assist in searching for appropriate implementation guide.
|
|
Summary
|
true
|
|
ImplementationGuide.copyright
|
|
Definition
|
A
copyright
statement
relating
to
the
implementation
guide
and/or
its
contents.
Copyright
statements
are
generally
legal
restrictions
on
the
use
and
publishing
of
the
details
of
the
constraints
and
mappings.
A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.
|
|
Control
|
0..1
|
|
Type
|
string
|
Alternate
Names
Alternate Names
|
License;
Restrictions
License; Restrictions
|
|
ImplementationGuide.fhirVersion
|
|
Definition
|
The
version
of
the
FHIR
specification
on
which
this
ImplementationGuide
is
based
-
this
is
the
formal
version
of
the
specification,
without
the
revision
number,
e.g.
[publication].[major].[minor],
which
is
1.0.2
for
this
version.
The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.4.0 for this version.
|
|
Control
|
0..1
|
|
Type
|
id
|
|
Summary
|
true
|
|
Comments
|
An
Implementation
Guide
should
specify
the
target
it
applies
to,
as
ImplementationGuides
are
rarely
valid
across
multiple
versions
of
FHIR.
An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR.
|
|
ImplementationGuide.dependency
|
|
Definition
|
Another
implementation
guide
that
this
implementation
depends
on.
Typically,
an
implementation
guide
uses
value
sets,
profiles
etc.defined
in
other
implementation
guides.
Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
|
|
Control
|
0..*
|
|
Summary
|
true
|
|
ImplementationGuide.dependency.type
|
|
Definition
|
How
the
dependency
is
represented
when
the
guide
is
published.
How the dependency is represented when the guide is published.
|
|
Control
|
1..1
|
|
Binding
|
GuideDependencyType:
How
a
dependency
is
represented
when
the
guide
is
published.
(
GuideDependencyType:
How a dependency is represented when the guide is published.
(
Required
)
|
|
Type
|
code
|
|
Summary
|
true
|
|
Comments
|
For
information
about
processing
included
guides,
see
[Including
Guides]{implementationguide.html#include}.
For information about processing included guides, see [Including Guides]{implementationguide.html#include}.
|
|
ImplementationGuide.dependency.uri
|
|
Definition
|
Where
the
dependency
is
located.
Where the dependency is located.
|
|
Control
|
1..1
|
|
Type
|
uri
|
|
Summary
|
true
|
|
Comments
|
When
a
guide
is
published,
and
the
type
is
'include',
this
will
be
a
relative
reference
within
the
guide.
When a guide is published, and the type is 'include', this will be a relative reference within the guide.
|
|
ImplementationGuide.package
|
|
Definition
|
A
logical
group
of
resources.
Logical
groups
can
be
used
when
building
pages.
A logical group of resources. Logical groups can be used when building pages.
|
|
Control
|
1..*
|
|
Summary
|
true
|
|
ImplementationGuide.package.name
|
|
Definition
|
The
name
for
the
group,
as
used
in
page.package.
The name for the group, as used in page.package.
|
|
Control
|
1..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
ImplementationGuide.package.description
|
|
Definition
|
Human
readable
text
describing
the
package.
Human readable text describing the package.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
ImplementationGuide.package.resource
|
|
Definition
|
A
resource
that
is
part
of
the
implementation
guide.
Conformance
resources
(value
set,
structure
definition,
conformance
statements
etc.)
are
obvious
candidates
for
inclusion,
but
any
kind
of
resource
can
be
included
as
an
example
resource.
A resource that is part of the implementation guide. Conformance resources (value set, structure definition, conformance statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
|
|
Control
|
1..*
|
|
Summary
|
true
|
ImplementationGuide.package.resource.purpose
ImplementationGuide.package.resource.example
|
|
Definition
|
Why
the
resource
is
included
in
the
guide.
Whether a resource is included in the guide as part of the rules defined by the guide, or just as an example of a resource that conforms to the rules and/or help implementers understand the intent of the guide.
|
|
Control
|
1..1
|
Binding
GuideResourcePurpose:
Why
a
resource
is
included
in
the
guide.
(
Required
)
|
Type
|
code
boolean
|
Requirements
This
element
is
provided
so
that
implementation
guide
tooling
does
not
have
to
guess
the
purpose
of
including
a
resource
in
the
implementation
guide
based
on
the
type
or
context.
|
Summary
|
true
|
|
Comments
|
The
purpose
alters
the
way
that
a
resource
is
handled
when
a
guide
is
built.
At
present,
only
value
set
and
concept
map
resources
are
allowed
for
terminology
resources,
and
only
StructureDefinition,
SearchParameter,
and
OperationDefinition
for
profile.
Dictionaries
must
be
bundles
of
DataElement
or
Medication
at
this
time.
Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.
|
|
ImplementationGuide.package.resource.name
|
|
Definition
|
A
human
assigned
name
for
the
resource.
All
resources
SHOULD
have
a
name,
but
the
name
may
be
extracted
from
the
resource
(e.g.
ValueSet.name).
A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
ImplementationGuide.package.resource.description
|
|
Definition
|
A
description
of
the
reason
that
a
resource
has
been
included
in
the
implementation
guide.
A description of the reason that a resource has been included in the implementation guide.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Comments
|
This
is
mostly
used
with
examples
to
explain
why
it
is
present
(though
they
can
have
extensive
comments
in
the
examples).
This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).
|
|
ImplementationGuide.package.resource.acronym
|
|
Definition
|
A
short
code
that
may
be
used
to
identify
the
resource
throughout
the
implementation
guide.
A short code that may be used to identify the resource throughout the implementation guide.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Comments
|
This
is
used
when
generating
schematrons
from
profiles,
for
example,
but
has
other
uses.
Publishing
tooling
may
autogenerate
this
value,
but
a
human
assigned
value
is
more
useful.
This
value
must
be
unique
within
an
implementation
guide
(across
included
guides
as
well).
This is used when generating schematrons from profiles, for example, but has other uses. Publishing tooling may autogenerate this value, but a human assigned value is more useful. This value must be unique within an implementation guide (across included guides as well).
|
|
ImplementationGuide.package.resource.source[x]
|
|
Definition
|
Where
this
resource
is
found.
Where this resource is found.
|
|
Control
|
1..1
|
|
Type
|
uri
|
Reference
(
Any
)
|
[x]
Note
[x] Note
|
See
Choice
of
Data
Types
for
further
information
about
how
to
use
[x]
See
Choice of Data Types
for further information about how to use [x]
|
|
Summary
|
true
|
|
Comments
|
Usually
this
is
a
relative
URL
that
locates
the
resource
within
the
implementation
guide.
If
you
authoring
an
implementation
guide,
and
will
publish
it
using
the
FHIR
publication
tooling,
use
a
URI
that
may
point
to
a
resource,
or
to
one
of
various
alternative
representations
(e.g.
spreadsheet).
The
tooling
will
convert
this
when
it
publishes
it.
Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.
|
|
ImplementationGuide.package.resource.exampleFor
|
|
Definition
|
Another
resource
that
this
resource
is
an
example
for.
This
is
mostly
used
for
resources
that
are
included
as
examples
of
StructureDefinitions.
Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.
|
|
Control
|
0..1
|
|
Type
|
Reference
(
StructureDefinition
)
|
|
Comments
|
Examples:
*
StructureDefinition
->
Any
*
ValueSet
->
expansion
*
OperationDefinition
->
Parameters
*
Questionnaire
->
QuestionnaireResponse.
Examples: * StructureDefinition -> Any * ValueSet -> expansion * OperationDefinition -> Parameters * Questionnaire -> QuestionnaireResponse.
|
|
ImplementationGuide.global
|
|
Definition
|
A
set
of
profiles
that
all
resources
covered
by
this
implementation
guide
must
conform
to.
A set of profiles that all resources covered by this implementation guide must conform to.
|
|
Control
|
0..*
|
|
Summary
|
true
|
|
Comments
|
See
Default
Profiles
for
a
discussion
of
which
resources
are
'covered'
by
an
implementation
guide.
See
Default Profiles
for a discussion of which resources are 'covered' by an implementation guide. |
|
ImplementationGuide.global.type
|
|
Definition
|
The
type
of
resource
that
all
instances
must
conform
to.
The type of resource that all instances must conform to.
|
|
Control
|
1..1
|
|
Binding
|
ResourceType:
Any
defined
Resource
Type
name
ResourceType:
Any defined Resource Type name
|
|
Type
|
code
|
|
Summary
|
true
|
|
Comments
|
The
type
must
match
that
of
the
profile
that
is
referred
to,
but
is
made
explicit
here
as
a
denormalization
so
that
a
system
processing
the
implementation
guide
resource
knows
which
resources
the
profile
applies
to
even
if
the
profile
itself
is
not
available.
The type must match that of the profile that is referred to, but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available.
|
|
ImplementationGuide.global.profile
|
|
Definition
|
A
reference
to
the
profile
that
all
instances
must
conform
to.
A reference to the profile that all instances must conform to.
|
|
Control
|
1..1
|
|
Type
|
Reference
(
StructureDefinition
)
|
|
Summary
|
true
|
|
ImplementationGuide.binary
|
|
Definition
|
A
binary
file
that
is
included
in
the
implementation
guide
when
it
is
published.
A binary file that is included in the implementation guide when it is published.
|
|
Control
|
0..*
|
|
Type
|
uri
|
|
Comments
|
This
is
principally
included
for
the
FHIR
publishing
tool,
but
may
be
useful
when
extracting
and
reusing
content
from
the
implementation
guide.
This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide.
|
|
ImplementationGuide.page
|
|
Definition
|
A
page
/
section
in
the
implementation
guide.
The
root
page
is
the
implementation
guide
home
page.
A page / section in the implementation guide. The root page is the implementation guide home page.
|
|
Control
|
1..1
|
|
Summary
|
true
|
|
Comments
|
Pages
automatically
become
sections
if
they
have
sub-pages.
By
convention,
the
home
page
is
called
index.html.
Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.
|
|
ImplementationGuide.page.source
|
|
Definition
|
The
source
address
for
the
page.
The source address for the page.
|
|
Control
|
1..1
|
|
Type
|
uri
|
|
Summary
|
true
|
|
Comments
|
The
publishing
tool
will
autogenerate
source
for
list
(source
=
n/a),
and
inject
included
implementations
for
include
(source
=
uri
of
guide
to
include).
The publishing tool will autogenerate source for list (source = n/a), and inject included implementations for include (source = uri of guide to include).
|
|
ImplementationGuide.page.name
|
|
Definition
|
A
short
name
used
to
represent
this
page
in
navigational
structures
such
as
table
of
contents,
bread
crumbs,
etc.
A short name used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
|
|
Control
|
1..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
ImplementationGuide.page.kind
|
|
Definition
|
The
kind
of
page
that
this
is.
Some
pages
are
autogenerated
(list,
example),
and
other
kinds
are
of
interest
so
that
tools
can
navigate
the
user
to
the
page
of
interest.
The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest.
|
|
Control
|
1..1
|
|
Binding
|
GuidePageKind:
The
kind
of
an
included
page.
(
GuidePageKind:
The kind of an included page.
(
Required
)
|
|
Type
|
code
|
|
Summary
|
true
|
|
ImplementationGuide.page.type
|
|
Definition
|
For
constructed
pages,
what
kind
of
resources
to
include
in
the
list.
For constructed pages, what kind of resources to include in the list.
|
|
Control
|
0..*
|
|
Binding
|
ResourceType:
Any
defined
Resource
Type
name
ResourceType:
Any defined Resource Type name
|
|
Type
|
code
|
|
ImplementationGuide.page.package
|
|
Definition
|
For
constructed
pages,
a
list
of
packages
to
include
in
the
page
(or
else
empty
for
everything).
For constructed pages, a list of packages to include in the page (or else empty for everything).
|
|
Control
|
0..*
|
|
Type
|
string
|
|
ImplementationGuide.page.format
|
|
Definition
|
The
format
of
the
page.
The format of the page.
|
|
Control
|
0..1
|
|
Binding
|
MimeType
MimeType
:
:
Required
:
BCP
13
(RFCs
2045,
2046,
2047,
4288,
4289
and
2049)
:
BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
(The
mime
type
of
an
attachment.
Any
valid
mime
type
is
allowed.)
(The mime type of an attachment. Any valid mime type is allowed.)
|
|
Type
|
code
|
|
Comments
|
This
is
primarily
for
the
publishing
tool,
that
will
convert
all
pages
to
html
format.
HTML
pages
are
pre-processed,
see
xxxx.
This is primarily for the publishing tool, that will convert all pages to html format. HTML pages are pre-processed, see xxxx.
|
|
ImplementationGuide.page.page
|
|
Definition
|
Nested
Pages/Sections
under
this
page.
Nested Pages/Sections under this page.
|
|
Control
|
0..*
|
|
Type
|
See
ImplementationGuide.page
See ImplementationGuide.page
|
|
Comments
|
The
implementation
guide
breadcrumbs
are
generated
from
this
structure.
The implementation guide breadcrumbs are generated from this structure.
|
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:43+1100.
Links:
Search