Release
4B
5
Ballot
Clinical
Reasoning
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
|
Clinical
Decision
Support
Work
Group
|
Maturity Level : 0 | Trial Use | Security Category : Business | Compartments : Not linked to any defined compartments |
The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
Note to Balloters: FMG
Trial-Use Note:The FHIR Management Group has provisionally approved the Citation Resource with the qualification that we will continue to evaluate its appropriateness as it develops in the community.The Citation Resource content here is from the R5 specification ( https://build.fhir.org/citation.html ) and should be considered Draft (not Trial use) within the R4B specification. There is no active development of Citation Resource in the R4B branch.
- Please share feedback, suggestions, and reports of your use of the Citation Resource with the CDS Work Group or through https://confluence.hl7.org/display/CDS/EBMonFHIR
The scope of the Citation Resource is to describe any aspect of identification, location, authorship, and contributorship to a journal article, report, document, resource, or other knowledge artifact. Citations are used extensively in scholarly communication and important for documenting the evidence or source behind statements of fact, opinion, and interpretation. Citations are also used for acknowledgement of the contributions of individuals and groups to the creation and advancement of knowledge.
Across the academic and scientific community citations are used extensively to reference the knowledge artifacts contributing to current work. For any community searching for reports of research or scholarly publications (such as searching MEDLINE) the citations contain the metadata used for such searches. Standardization of citations supports interoperability across citation managers and adaptation to current needs, such as reports being available on preprint servers before 'final' peer-reviewed published form, need to cite datasets or other alternative forms of expression, or the ability to support citation of FHIR Resources where the FHIR Resource represents research or scholarly publication.
The Resource can accommodate both human and machine readers. The summary element provides human-readable information.
The Citation Resource has multiple elements containing metadata that describe the citation resource itself, and a citedArtifact element containing metadata that describe the article or artifact being cited.
Attribution of scholarly contributions is expressed in the citedArtifact.contributorship element, which has grown more complex as the nature of authorship and the concerns for credit and acknowledgement are increasingly complex. If an individualized attribution structure is not required, the citedArtifact.contributorship.summary element will do.
"Publication" must now cover books, books series, article series, database registries, database updates, and the like. The element, citedArtifact.publicationForm , enables this description. Within citedArtifact.publicationForm , the publishedIn element identifies the largest container (journal, book, database, or newspaper), the periodicRelease element identifies the periodic issue, and the remaining elements (covering dates, language, and pagination) are specific to the artifact being cited.
Any resource may have common metadata including publisher, authors, reviewers, editors, endorsers, identifiers and location concepts for the resource. The Citation Resource is expected to be used primarily for citing things that are not FHIR Resources. There is NOT an expectation to provide Citations for most FHIR Resources. However, FHIR Resources can be the subject of Citation Resources when there is additional needs beyond common metadata to use the FHIR Resource as the cited source in other contexts or to support scholarly and scientific contribution attribution to the FHIR Resource content.
The Provenance Resource is used to track the contributions to a resource as it occurs, especially for purposes of confirming authenticity and trust. Citation.citedArtifact.contributorship is used to report the attribution of contributions to the cited artifact, especially for purposes of recognition and acknowledgement, but is not directly reporting the data to support authenticity of the contributions.
The DocumentReference Resource is described as a reference to a document of any kind for any purpose. As the DocumentReference Resource was developed for healthcare data exchange it is modeled to support individualized provenance, security, and artifact relationships as often needed in this context. The Citation Resource was developed for the reference to knowledge artifacts commonly used in scientific and scholarly communication so is modeled to support identification, attribution, classification, status tracking, and representation (summary) of the citation.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
Citation
|
TU | DomainResource |
A
description
of
identification,
location,
or
contributorship
of
a
publication
(article
or
artifact)
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: MetadataResource |
|
url
|
Σ C | 0..1 | uri |
Canonical
identifier
for
this
citation,
represented
as
a
globally
unique
URI
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
identifier
|
Σ | 0..* | Identifier |
Identifier
for
the
Citation
resource
itself
|
|
version
|
Σ | 0..1 | string |
Business
version
of
the
citation
|
|
name
|
Σ
|
0..1 | string |
Name
for
this
citation
(computer
friendly)
|
|
title
|
Σ | 0..1 | string |
Name
for
this
citation
(human
friendly)
|
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
|
experimental
|
Σ | 0..1 | boolean |
For
testing
purposes,
not
real
usage
|
|
date
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
publisher
|
Σ | 0..1 | string |
The
publisher
of
the
Citation,
not
the
publisher
of
the
article
or
artifact
being
cited
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
of
the
Citation
Resource
|
|
description
|
0..1 | markdown |
Natural
language
description
of
the
citation
|
|
|
useContext
|
Σ | 0..* | UsageContext |
The
context
that
the
Citation
Resource
content
is
intended
to
support
|
|
jurisdiction
|
Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
citation
(if
applicable)
Jurisdiction ( Extensible ) |
|
purpose
|
0..1 | markdown |
Why
this
citation
is
defined
|
|
|
copyright
|
0..1 | markdown |
Use
and/or
publishing
restrictions
for
the
Citation,
not
for
the
cited
artifact
|
|
|
approvalDate
|
0..1 | date |
When
the
citation
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
When
the
citation
was
last
reviewed
|
|
|
effectivePeriod
|
Σ | 0..1 | Period |
When
the
citation
is
expected
to
be
used
|
|
author
|
0..* | ContactDetail |
Who
authored
the
Citation
|
|
|
editor
|
0..* | ContactDetail |
Who
edited
the
Citation
|
|
|
reviewer
|
0..* | ContactDetail |
Who
reviewed
the
Citation
|
|
|
endorser
|
0..* | ContactDetail |
Who
endorsed
the
Citation
|
|
summary
|
0..* | BackboneElement |
A
human-readable
display
of
the
citation
|
|
style
|
0..1 | CodeableConcept |
Format
for
display
of
the
citation
CitationSummaryStyle ( Extensible ) |
|
text
|
Σ | 1..1 | markdown |
The
human-readable
display
of
the
citation
|
|
classification
|
0..* | BackboneElement |
The
assignment
to
an
organizing
scheme
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
classifier
(e.g.
publication
type,
keyword)
CitationClassificationType ( Extensible ) |
|
|
classifier
|
0..* | CodeableConcept |
The
specific
classification
value
CitationArtifactClassifier ( Example ) |
|
|
note
|
0..* | Annotation |
Used
for
general
notes
and
annotations
not
coded
elsewhere
|
|
|
currentState
|
0..* | CodeableConcept |
The
status
of
the
citation
CitationStatusType ( Example ) |
|
|
statusDate
|
0..* | BackboneElement |
An
effective
date
or
period
for
a
status
of
the
citation
|
|
|
activity
|
1..1 | CodeableConcept |
Classification
of
the
status
CitationStatusType ( Example ) |
|
|
actual
|
0..1 | boolean |
Either
occurred
or
expected
|
|
|
period
|
1..1 | Period |
When
the
status
started
and/or
ended
|
|
|
relatedArtifact
|
0..* |
|
Artifact
related
to
the
Citation
Resource
|
|
citedArtifact
|
0..1 | BackboneElement |
The
article
or
artifact
being
described
|
|
identifier
|
Σ | 0..* | Identifier |
May
include
DOI,
PMID,
PMCID,
etc.
|
|
relatedIdentifier
|
Σ | 0..* | Identifier |
May
include
trial
registry
identifiers
|
|
dateAccessed
|
Σ | 0..1 | dateTime |
When
the
cited
artifact
was
accessed
|
|
version
|
0..1 | BackboneElement |
The
defined
version
of
the
cited
artifact
|
|
|
value
|
1..1 | string |
The
version
number
or
other
version
identifier
|
|
baseCitation
|
0..1 | Reference ( Citation ) |
Citation
for
the
main
version
of
the
cited
artifact
|
|
|
currentState
|
0..* | CodeableConcept |
The
status
of
the
cited
artifact
CitedArtifactStatusType ( Extensible ) |
|
|
statusDate
|
0..* | BackboneElement |
An
effective
date
or
period
for
a
status
of
the
cited
artifact
|
|
|
activity
|
1..1 | CodeableConcept |
Classification
of
the
status
CitedArtifactStatusType ( Extensible ) |
|
|
actual
|
0..1 | boolean |
Either
occurred
or
expected
|
|
|
period
|
1..1 | Period |
When
the
status
started
and/or
ended
|
|
|
title
|
0..* | BackboneElement |
The
title
details
of
the
article
or
artifact
|
|
|
type
|
0..* | CodeableConcept |
The
kind
of
title
TitleType ( Extensible ) |
|
|
language
|
0..1 | CodeableConcept |
Used
to
express
the
specific
language
Common Languages ( Preferred ) |
|
|
text
|
1..1 | markdown |
The
title
of
the
article
or
artifact
|
|
|
abstract
|
0..* | BackboneElement |
Summary
of
the
article
or
artifact
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
abstract
CitedArtifactAbstractType ( Extensible ) |
|
|
language
|
0..1 | CodeableConcept |
Used
to
express
the
specific
language
Common Languages ( Preferred ) |
|
|
text
|
1..1 | markdown |
Abstract
content
|
|
|
copyright
|
0..1 | markdown |
Copyright
notice
for
the
abstract
|
|
|
part
|
0..1 | BackboneElement |
The
component
of
the
article
or
artifact
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
component
CitedArtifactPartType ( Extensible ) |
|
|
value
|
0..1 | string |
The
specification
of
the
component
|
|
|
baseCitation
|
0..1 | Reference ( Citation ) |
The
citation
for
the
full
article
or
artifact
|
|
|
relatesTo
|
0..* | BackboneElement |
The
artifact
related
to
the
cited
artifact
|
|
|
type
| 1..1 | code |
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
|
reprint
|
reprint-of
RelatedArtifactTypeExpanded ( Required ) | |
|
|
|
CodeableConcept |
|
|
|
label
|
|
|
|
|
|
display
|
|
string |
|
|
|
|
0..1 |
|
Bibliographic
citation
for
the
artifact
|
|
|
|
0..1 |
|
What
document
is
being
referenced
|
|
|
|
0..1 |
|
What
artifact
is
being
referenced
|
|
|
resourceReference
|
0..1 |
|
What
artifact,
if
not
a
conformance
resource
|
|
|
publicationForm
|
0..* | BackboneElement |
If
multiple,
used
to
represent
alternative
forms
of
the
article
that
are
not
separate
citations
|
|
|
publishedIn
|
0..1 | BackboneElement |
The
collection
the
cited
article
or
artifact
is
published
in
|
|
|
type
|
0..1 | CodeableConcept |
Kind
of
container
(e.g.
Periodical,
database,
or
book)
PublishedInType ( Extensible ) |
|
|
identifier
|
0..* | Identifier |
Journal
identifiers
include
ISSN,
ISO
Abbreviation
and
NLMuniqueID;
Book
identifiers
include
ISBN
|
|
|
title
|
0..1 | string |
Name
of
the
database
or
title
of
the
book
or
journal
|
|
|
publisher
|
0..1 | Reference ( Organization ) |
Name
of
the
publisher
|
|
|
publisherLocation
|
0..1 | string |
Geographic
location
of
the
publisher
|
|
|
citedMedium
|
0..1 |
|
Internet
or
Print
CitedMedium ( Extensible ) |
|
|
volume
|
0..1 | string |
Volume
number
of
journal
in
which
the
article
is
published
|
|
|
issue
|
0..1 | string |
Issue,
part
or
supplement
of
journal
in
which
the
article
is
published
|
|
|
|
0..1 |
|
|
|
|
|
0..1 | string |
|
|
|
|
0..1 | string |
|
|
|
|
0..1 | string |
|
|
|
|
0..1 | string |
|
|
|
articleDate
|
0..1 | dateTime |
The
date
the
article
was
added
to
the
database,
or
the
date
the
article
was
released
|
|
|
lastRevisionDate
|
0..1 | dateTime |
The
date
the
article
was
last
revised
or
updated
in
the
database
|
|
|
language
|
0..* | CodeableConcept |
Language
in
which
this
form
of
the
article
is
published
Common Languages ( Preferred ) |
|
|
accessionNumber
|
0..1 | string |
Entry
number
or
identifier
for
inclusion
in
a
database
|
|
|
pageString
|
0..1 | string |
Used
for
full
display
of
pagination
|
|
|
firstPage
|
0..1 | string |
Used
for
isolated
representation
of
first
page
|
|
|
lastPage
|
0..1 | string |
Used
for
isolated
representation
of
last
page
|
|
|
pageCount
|
0..1 | string |
Number
of
pages
or
screens
|
|
|
copyright
|
0..1 | markdown |
Copyright
notice
for
the
full
article
or
artifact
|
|
|
webLocation
|
0..* | BackboneElement |
Used
for
any
URL
for
the
article
or
artifact
cited
|
|
|
classifier
|
0..* | CodeableConcept |
Code
the
reason
for
different
URLs,
e.g.
abstract
and
full-text
|
|
|
url
|
0..1 | uri |
The
specific
URL
|
|
|
classification
|
0..* | BackboneElement |
The
assignment
to
an
organizing
scheme
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
classifier
(e.g.
publication
type,
keyword)
CitedArtifactClassificationType ( Extensible ) |
|
|
classifier
|
0..* | CodeableConcept |
The
specific
classification
value
CitationArtifactClassifier ( Example ) |
|
|
|
|
Reference
(
|
|
|
|
contributorship
|
0..1 | BackboneElement |
Attribution
of
authors
and
other
contributors
|
|
|
complete
|
0..1 | boolean |
Indicates
if
the
list
includes
all
authors
and/or
contributors
|
|
|
entry
|
0..* | BackboneElement |
An
individual
entity
named
in
the
list
|
|
|
contributor
|
|
|
|
|
|
|
0..1 | string |
Initials
for
forename
|
|
|
affiliation
|
|
|
Organizational
affiliation
|
|
|
|
0..* | CodeableConcept |
The
specific
contribution
ArtifactContributionType ( Extensible ) |
|
|
role
|
0..1 | CodeableConcept |
The
role
of
the
contributor
(e.g.
author,
editor,
reviewer)
ContributorRole ( Extensible ) |
|
|
contributionInstance
|
0..* | BackboneElement |
Contributions
with
accounting
for
time
or
number
|
|
|
type
|
1..1 | CodeableConcept |
The
specific
contribution
ArtifactContributionInstanceType ( Extensible ) |
|
|
time
|
0..1 | dateTime |
The
time
that
the
contribution
was
made
|
|
|
correspondingContact
|
0..1 | boolean |
Indication
of
which
contributor
is
the
corresponding
contributor
for
the
role
|
|
|
rankingOrder
|
0..1 | positiveInt |
Ranked
order
of
|
|
|
summary
|
0..* | BackboneElement |
Used
to
record
a
display
of
the
author/contributor
list
without
separate
coding
for
each
list
member
|
|
|
type
|
0..1 | CodeableConcept |
Either
authorList
or
contributorshipStatement
ContributorSummaryType ( Extensible ) |
|
|
style
|
0..1 | CodeableConcept |
The
format
for
the
display
string
ContributorSummaryStyle ( Extensible ) |
|
|
source
|
0..1 | CodeableConcept |
Used
to
code
the
producer
or
rule
for
creating
the
display
string
ContributorSummarySource ( Extensible ) |
|
|
value
|
1..1 | markdown |
The
display
string
for
the
author
list,
contributor
list,
or
contributorship
statement
|
|
|
note
|
0..* | Annotation |
Any
additional
information
or
content
for
the
article
or
artifact
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<Citation xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
<<url value="[uri]"/><!-- 0..1 Canonical identifier for this citation, represented as a globally unique URI --> <identifier><!-- 0..* Identifier Identifier for the Citation resource itself --></identifier> <version value="[string]"/><!-- 0..1 Business version of the citation --><<name value="[string]"/><!-- I 0..1 Name for this citation (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this citation (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited --> <contact><!-- 0..* ContactDetail Contact details for the publisher of the Citation Resource --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the citation --> <useContext><!-- 0..* UsageContext The context that the Citation Resource content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for citation (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this citation is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact --> <approvalDate value="[date]"/><!-- 0..1 When the citation was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the citation was last reviewed --> <effectivePeriod><!-- 0..1 Period When the citation is expected to be used --></effectivePeriod> <author><!-- 0..* ContactDetail Who authored the Citation --></author> <editor><!-- 0..* ContactDetail Who edited the Citation --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the Citation --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the Citation --></endorser> <summary> <!-- 0..* A human-readable display of the citation --> <style><!-- 0..1 CodeableConcept Format for display of the citation --></style> <text value="[markdown]"/><!-- 1..1 The human-readable display of the citation --> </summary> <classification> <!-- 0..* The assignment to an organizing scheme --> <type><!-- 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword) --></type> <classifier><!-- 0..* CodeableConcept The specific classification value --></classifier> </classification> <note><!-- 0..* Annotation Used for general notes and annotations not coded elsewhere --></note> <currentState><!-- 0..* CodeableConcept The status of the citation --></currentState> <statusDate> <!-- 0..* An effective date or period for a status of the citation --> <activity><!-- 1..1 CodeableConcept Classification of the status --></activity> <actual value="[boolean]"/><!-- 0..1 Either occurred or expected --> <period><!-- 1..1 Period When the status started and/or ended --></period> </statusDate>< <</relationshipType> <</targetClassifier> <</target[x]> </relatesTo><relatedArtifact><!-- 0..* RelatedArtifact Artifact related to the Citation Resource --></relatedArtifact> <citedArtifact> <!-- 0..1 The article or artifact being described --> <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier> <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier> <dateAccessed value="[dateTime]"/><!-- 0..1 When the cited artifact was accessed --> <version> <!-- 0..1 The defined version of the cited artifact --> <value value="[string]"/><!-- 1..1 The version number or other version identifier --> <baseCitation><!-- 0..1 Reference(Citation) Citation for the main version of the cited artifact --></baseCitation> </version> <currentState><!-- 0..* CodeableConcept The status of the cited artifact --></currentState> <statusDate> <!-- 0..* An effective date or period for a status of the cited artifact --> <activity><!-- 1..1 CodeableConcept Classification of the status --></activity> <actual value="[boolean]"/><!-- 0..1 Either occurred or expected --> <period><!-- 1..1 Period When the status started and/or ended --></period> </statusDate> <title> <!-- 0..* The title details of the article or artifact --> <type><!-- 0..* CodeableConcept The kind of title --></type> <language><!-- 0..1 CodeableConcept Used to express the specific language --></language> <text value="[markdown]"/><!-- 1..1 The title of the article or artifact --> </title> <abstract> <!-- 0..* Summary of the article or artifact --> <type><!-- 0..1 CodeableConcept The kind of abstract --></type> <language><!-- 0..1 CodeableConcept Used to express the specific language --></language> <text value="[markdown]"/><!-- 1..1 Abstract content --> <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the abstract --> </abstract> <part> <!-- 0..1 The component of the article or artifact --> <type><!-- 0..1 CodeableConcept The kind of component --></type> <value value="[string]"/><!-- 0..1 The specification of the component --> <baseCitation><!-- 0..1 Reference(Citation) The citation for the full article or artifact --></baseCitation> </part> <relatesTo> <!-- 0..* The artifact related to the cited artifact --><</relationshipType> <</targetClassifier> <</target[x]><type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of --> <classifier><!-- 0..* CodeableConcept Additional classifiers --></classifier> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- 0..1 What artifact is being referenced --> <resourceReference><!-- 0..1 Reference What artifact, if not a conformance resource --></resourceReference> </relatesTo> <publicationForm> <!-- 0..* If multiple, used to represent alternative forms of the article that are not separate citations --> <publishedIn> <!-- 0..1 The collection the cited article or artifact is published in --> <type><!-- 0..1 CodeableConcept Kind of container (e.g. Periodical, database, or book) --></type> <identifier><!-- 0..* Identifier Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN --></identifier> <title value="[string]"/><!-- 0..1 Name of the database or title of the book or journal --> <publisher><!-- 0..1 Reference(Organization) Name of the publisher --></publisher> <publisherLocation value="[string]"/><!-- 0..1 Geographic location of the publisher --> </publishedIn>< <</citedMedium> < < < < < < < < < </dateOfPublication> </periodicRelease><citedMedium><!-- 0..1 CodeableConcept Internet or Print --></citedMedium> <volume value="[string]"/><!-- 0..1 Volume number of journal in which the article is published --> <issue value="[string]"/><!-- 0..1 Issue, part or supplement of journal in which the article is published --> <publicationDateYear value="[string]"/><!-- 0..1 Year on which the issue of the journal was published --> <publicationDateMonth value="[string]"/><!-- 0..1 Month on which the issue of the journal was published --> <publicationDateDay value="[string]"/><!-- 0..1 Day on which the issue of the journal was published --> <publicationDateSeason value="[string]"/><!-- 0..1 Season on which the issue of the journal was published --> <publicationDateText value="[string]"/><!-- 0..1 Text representation of the date of which the issue of the journal was published --> <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released --> <lastRevisionDate value="[dateTime]"/><!-- 0..1 The date the article was last revised or updated in the database --> <language><!-- 0..* CodeableConcept Language in which this form of the article is published --></language> <accessionNumber value="[string]"/><!-- 0..1 Entry number or identifier for inclusion in a database --> <pageString value="[string]"/><!-- 0..1 Used for full display of pagination --> <firstPage value="[string]"/><!-- 0..1 Used for isolated representation of first page --> <lastPage value="[string]"/><!-- 0..1 Used for isolated representation of last page --> <pageCount value="[string]"/><!-- 0..1 Number of pages or screens --> <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the full article or artifact --> </publicationForm> <webLocation> <!-- 0..* Used for any URL for the article or artifact cited --><</type><classifier><!-- 0..* CodeableConcept Code the reason for different URLs, e.g. abstract and full-text --></classifier> <url value="[uri]"/><!-- 0..1 The specific URL --> </webLocation> <classification> <!-- 0..* The assignment to an organizing scheme --> <type><!-- 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword) --></type> <classifier><!-- 0..* CodeableConcept The specific classification value --></classifier>< <</person> <</organization> <</publisher> < < </whoClassified><artifactAssessment><!-- 0..* Reference(ArtifactAssessment) Complex or externally created classification --></artifactAssessment> </classification> <contributorship> <!-- 0..1 Attribution of authors and other contributors --> <complete value="[boolean]"/><!-- 0..1 Indicates if the list includes all authors and/or contributors --> <entry> <!-- 0..* An individual entity named in the list --><</name> < < <</identifier> < < < <</identifier> </affiliationInfo> <</address> <</telecom><contributor><!-- 1..1 Reference(Organization|Practitioner) The identity of the individual entity --></contributor> <forenameInitials value="[string]"/><!-- 0..1 Initials for forename --> <affiliation><!-- 0..* Reference(Organization|PractitionerRole) Organizational affiliation --></affiliation> <contributionType><!-- 0..* CodeableConcept The specific contribution --></contributionType> <role><!-- 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer) --></role> <contributionInstance> <!-- 0..* Contributions with accounting for time or number --> <type><!-- 1..1 CodeableConcept The specific contribution --></type> <time value="[dateTime]"/><!-- 0..1 The time that the contribution was made --> </contributionInstance> <correspondingContact value="[boolean]"/><!-- 0..1 Indication of which contributor is the corresponding contributor for the role --><<rankingOrder value="[positiveInt]"/><!-- 0..1 Ranked order of contribution --> </entry> <summary> <!-- 0..* Used to record a display of the author/contributor list without separate coding for each list member --> <type><!-- 0..1 CodeableConcept Either authorList or contributorshipStatement --></type> <style><!-- 0..1 CodeableConcept The format for the display string --></style> <source><!-- 0..1 CodeableConcept Used to code the producer or rule for creating the display string --></source> <value value="[markdown]"/><!-- 1..1 The display string for the author list, contributor list, or contributorship statement --> </summary> </contributorship> <note><!-- 0..* Annotation Any additional information or content for the article or artifact --></note> </citedArtifact> </Citation>
JSON Template
{
"resourceType" : "Citation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"url" : "<uri>", // Canonical identifier for this citation, represented as a globally unique URI
"identifier" : [{ Identifier }], // Identifier for the Citation resource itself
"version" : "<string>", // Business version of the citation
"
"name" : "<string>", // I Name for this citation (computer friendly)
"title" : "<string>", // Name for this citation (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // The publisher of the Citation, not the publisher of the article or artifact being cited
"contact" : [{ ContactDetail }], // Contact details for the publisher of the Citation Resource
"description" : "<markdown>", // Natural language description of the citation
"useContext" : [{ UsageContext }], // The context that the Citation Resource content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation (if applicable)
"purpose" : "<markdown>", // Why this citation is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions for the Citation, not for the cited artifact
"approvalDate" : "<date>", // When the citation was approved by publisher
"lastReviewDate" : "<date>", // When the citation was last reviewed
"effectivePeriod" : { Period }, // When the citation is expected to be used
"author" : [{ ContactDetail }], // Who authored the Citation
"editor" : [{ ContactDetail }], // Who edited the Citation
"reviewer" : [{ ContactDetail }], // Who reviewed the Citation
"endorser" : [{ ContactDetail }], // Who endorsed the Citation
"summary" : [{ // A human-readable display of the citation
"style" : { CodeableConcept }, // Format for display of the citation
"text" : "<markdown>" // R! The human-readable display of the citation
}],
"classification" : [{ // The assignment to an organizing scheme
"type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
"classifier" : [{ CodeableConcept }] // The specific classification value
}],
"note" : [{ Annotation }], // Used for general notes and annotations not coded elsewhere
"currentState" : [{ CodeableConcept }], // The status of the citation
"statusDate" : [{ // An effective date or period for a status of the citation
"activity" : { CodeableConcept }, // R! Classification of the status
"actual" : <boolean>, // Either occurred or expected
"period" : { Period } // R! When the status started and/or ended
}],
"
"
"
">"
" }
" }
" }
}],
"relatedArtifact" : [{ RelatedArtifact }], // Artifact related to the Citation Resource
"citedArtifact" : { // The article or artifact being described
"identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc.
"relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers
"dateAccessed" : "<dateTime>", // When the cited artifact was accessed
"version" : { // The defined version of the cited artifact
"value" : "<string>", // R! The version number or other version identifier
"baseCitation" : { Reference(Citation) } // Citation for the main version of the cited artifact
},
"currentState" : [{ CodeableConcept }], // The status of the cited artifact
"statusDate" : [{ // An effective date or period for a status of the cited artifact
"activity" : { CodeableConcept }, // R! Classification of the status
"actual" : <boolean>, // Either occurred or expected
"period" : { Period } // R! When the status started and/or ended
}],
"title" : [{ // The title details of the article or artifact
"type" : [{ CodeableConcept }], // The kind of title
"language" : { CodeableConcept }, // Used to express the specific language
"text" : "<markdown>" // R! The title of the article or artifact
}],
"abstract" : [{ // Summary of the article or artifact
"type" : { CodeableConcept }, // The kind of abstract
"language" : { CodeableConcept }, // Used to express the specific language
"text" : "<markdown>", // R! Abstract content
"copyright" : "<markdown>" // Copyright notice for the abstract
}],
"part" : { // The component of the article or artifact
"type" : { CodeableConcept }, // The kind of component
"value" : "<string>", // The specification of the component
"baseCitation" : { Reference(Citation) } // The citation for the full article or artifact
},
"relatesTo" : [{ // The artifact related to the cited artifact
"
"
">"
" }
" }
" }
"type" : "<code>", // R! documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
"classifier" : [{ CodeableConcept }], // Additional classifiers
"label" : "<string>", // Short label
"display" : "<string>", // Brief description of the related artifact
"citation" : "<markdown>", // Bibliographic citation for the artifact
"document" : { Attachment }, // What document is being referenced
"resource" : "<canonical>", // What artifact is being referenced
"resourceReference" : { Reference } // What artifact, if not a conformance resource
}],
"publicationForm" : [{ // If multiple, used to represent alternative forms of the article that are not separate citations
"publishedIn" : { // The collection the cited article or artifact is published in
"type" : { CodeableConcept }, // Kind of container (e.g. Periodical, database, or book)
"identifier" : [{ Identifier }], // Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
"title" : "<string>", // Name of the database or title of the book or journal
"publisher" : { Reference(Organization) }, // Name of the publisher
"publisherLocation" : "<string>" // Geographic location of the publisher
},
"
"
"
"
"
"
"
"
"
"
"
}
},
"citedMedium" : { CodeableConcept }, // Internet or Print
"volume" : "<string>", // Volume number of journal in which the article is published
"issue" : "<string>", // Issue, part or supplement of journal in which the article is published
"publicationDateYear" : "<string>", // Year on which the issue of the journal was published
"publicationDateMonth" : "<string>", // Month on which the issue of the journal was published
"publicationDateDay" : "<string>", // Day on which the issue of the journal was published
"publicationDateSeason" : "<string>", // Season on which the issue of the journal was published
"publicationDateText" : "<string>", // Text representation of the date of which the issue of the journal was published
"articleDate" : "<dateTime>", // The date the article was added to the database, or the date the article was released
"lastRevisionDate" : "<dateTime>", // The date the article was last revised or updated in the database
"language" : [{ CodeableConcept }], // Language in which this form of the article is published
"accessionNumber" : "<string>", // Entry number or identifier for inclusion in a database
"pageString" : "<string>", // Used for full display of pagination
"firstPage" : "<string>", // Used for isolated representation of first page
"lastPage" : "<string>", // Used for isolated representation of last page
"pageCount" : "<string>", // Number of pages or screens
"copyright" : "<markdown>" // Copyright notice for the full article or artifact
}],
"webLocation" : [{ // Used for any URL for the article or artifact cited
"
"classifier" : [{ CodeableConcept }], // Code the reason for different URLs, e.g. abstract and full-text
"url" : "<uri>" // The specific URL
}],
"classification" : [{ // The assignment to an organizing scheme
"type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
"classifier" : [{ CodeableConcept }], // The specific classification value
"
"
"
"
"
"
}
"artifactAssessment" : [{ Reference(ArtifactAssessment) }] // Complex or externally created classification
}],
"contributorship" : { // Attribution of authors and other contributors
"complete" : <boolean>, // Indicates if the list includes all authors and/or contributors
"entry" : [{ // An individual entity named in the list
"
"
"
"
"
"
"
"
}],
"
"
"contributor" : { Reference(Organization|Practitioner) }, // R! The identity of the individual entity
"forenameInitials" : "<string>", // Initials for forename
"affiliation" : [{ Reference(Organization|PractitionerRole) }], // Organizational affiliation
"contributionType" : [{ CodeableConcept }], // The specific contribution
"role" : { CodeableConcept }, // The role of the contributor (e.g. author, editor, reviewer)
"contributionInstance" : [{ // Contributions with accounting for time or number
"type" : { CodeableConcept }, // R! The specific contribution
"time" : "<dateTime>" // The time that the contribution was made
}],
"correspondingContact" : <boolean>, // Indication of which contributor is the corresponding contributor for the role
"
"rankingOrder" : "<positiveInt>" // Ranked order of contribution
}],
"summary" : [{ // Used to record a display of the author/contributor list without separate coding for each list member
"type" : { CodeableConcept }, // Either authorList or contributorshipStatement
"style" : { CodeableConcept }, // The format for the display string
"source" : { CodeableConcept }, // Used to code the producer or rule for creating the display string
"value" : "<markdown>" // R! The display string for the author list, contributor list, or contributorship statement
}]
},
"note" : [{ Annotation }] // Any additional information or content for the article or artifact
}
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir:fhir:Citation.url [ uri ]; # 0..1 Canonical identifier for this citation, represented as a globally unique URI fhir:Citation.identifier [ Identifier ], ... ; # 0..* Identifier for the Citation resource itself fhir:Citation.version [ string ]; # 0..1 Business version of the citationfhir:fhir:Citation.name [ string ]; # 0..1 I Name for this citation (computer friendly) fhir:Citation.title [ string ]; # 0..1 Name for this citation (human friendly) fhir:Citation.status [ code ]; # 1..1 draft | active | retired | unknown fhir:Citation.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:Citation.date [ dateTime ]; # 0..1 Date last changed fhir:Citation.publisher [ string ]; # 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited fhir:Citation.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher of the Citation Resource fhir:Citation.description [ markdown ]; # 0..1 Natural language description of the citation fhir:Citation.useContext [ UsageContext ], ... ; # 0..* The context that the Citation Resource content is intended to support fhir:Citation.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for citation (if applicable) fhir:Citation.purpose [ markdown ]; # 0..1 Why this citation is defined fhir:Citation.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact fhir:Citation.approvalDate [ date ]; # 0..1 When the citation was approved by publisher fhir:Citation.lastReviewDate [ date ]; # 0..1 When the citation was last reviewed fhir:Citation.effectivePeriod [ Period ]; # 0..1 When the citation is expected to be used fhir:Citation.author [ ContactDetail ], ... ; # 0..* Who authored the Citation fhir:Citation.editor [ ContactDetail ], ... ; # 0..* Who edited the Citation fhir:Citation.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the Citation fhir:Citation.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the Citation fhir:Citation.summary [ # 0..* A human-readable display of the citation fhir:Citation.summary.style [ CodeableConcept ]; # 0..1 Format for display of the citation fhir:Citation.summary.text [ markdown ]; # 1..1 The human-readable display of the citation ], ...; fhir:Citation.classification [ # 0..* The assignment to an organizing scheme fhir:Citation.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword) fhir:Citation.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification value ], ...; fhir:Citation.note [ Annotation ], ... ; # 0..* Used for general notes and annotations not coded elsewhere fhir:Citation.currentState [ CodeableConcept ], ... ; # 0..* The status of the citation fhir:Citation.statusDate [ # 0..* An effective date or period for a status of the citation fhir:Citation.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status fhir:Citation.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected fhir:Citation.statusDate.period [ Period ]; # 1..1 When the status started and/or ended ], ...;fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir:) ] fhir: ] ], ...;fhir:Citation.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Artifact related to the Citation Resource fhir:Citation.citedArtifact [ # 0..1 The article or artifact being described fhir:Citation.citedArtifact.identifier [ Identifier ], ... ; # 0..* May include DOI, PMID, PMCID, etc. fhir:Citation.citedArtifact.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers fhir:Citation.citedArtifact.dateAccessed [ dateTime ]; # 0..1 When the cited artifact was accessed fhir:Citation.citedArtifact.version [ # 0..1 The defined version of the cited artifact fhir:Citation.citedArtifact.version.value [ string ]; # 1..1 The version number or other version identifier fhir:Citation.citedArtifact.version.baseCitation [ Reference(Citation) ]; # 0..1 Citation for the main version of the cited artifact ]; fhir:Citation.citedArtifact.currentState [ CodeableConcept ], ... ; # 0..* The status of the cited artifact fhir:Citation.citedArtifact.statusDate [ # 0..* An effective date or period for a status of the cited artifact fhir:Citation.citedArtifact.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status fhir:Citation.citedArtifact.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected fhir:Citation.citedArtifact.statusDate.period [ Period ]; # 1..1 When the status started and/or ended ], ...; fhir:Citation.citedArtifact.title [ # 0..* The title details of the article or artifact fhir:Citation.citedArtifact.title.type [ CodeableConcept ], ... ; # 0..* The kind of title fhir:Citation.citedArtifact.title.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.citedArtifact.title.text [ markdown ]; # 1..1 The title of the article or artifact ], ...; fhir:Citation.citedArtifact.abstract [ # 0..* Summary of the article or artifact fhir:Citation.citedArtifact.abstract.type [ CodeableConcept ]; # 0..1 The kind of abstract fhir:Citation.citedArtifact.abstract.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.citedArtifact.abstract.text [ markdown ]; # 1..1 Abstract content fhir:Citation.citedArtifact.abstract.copyright [ markdown ]; # 0..1 Copyright notice for the abstract ], ...; fhir:Citation.citedArtifact.part [ # 0..1 The component of the article or artifact fhir:Citation.citedArtifact.part.type [ CodeableConcept ]; # 0..1 The kind of component fhir:Citation.citedArtifact.part.value [ string ]; # 0..1 The specification of the component fhir:Citation.citedArtifact.part.baseCitation [ Reference(Citation) ]; # 0..1 The citation for the full article or artifact ]; fhir:Citation.citedArtifact.relatesTo [ # 0..* The artifact related to the cited artifactfhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir:) ] fhir: ]fhir:Citation.citedArtifact.relatesTo.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of fhir:Citation.citedArtifact.relatesTo.classifier [ CodeableConcept ], ... ; # 0..* Additional classifiers fhir:Citation.citedArtifact.relatesTo.label [ string ]; # 0..1 Short label fhir:Citation.citedArtifact.relatesTo.display [ string ]; # 0..1 Brief description of the related artifact fhir:Citation.citedArtifact.relatesTo.citation [ markdown ]; # 0..1 Bibliographic citation for the artifact fhir:Citation.citedArtifact.relatesTo.document [ Attachment ]; # 0..1 What document is being referenced fhir:Citation.citedArtifact.relatesTo.resource [ canonical ]; # 0..1 What artifact is being referenced fhir:Citation.citedArtifact.relatesTo.resourceReference [ Reference ]; # 0..1 What artifact, if not a conformance resource ], ...; fhir:Citation.citedArtifact.publicationForm [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations fhir:Citation.citedArtifact.publicationForm.publishedIn [ # 0..1 The collection the cited article or artifact is published in fhir:Citation.citedArtifact.publicationForm.publishedIn.type [ CodeableConcept ]; # 0..1 Kind of container (e.g. Periodical, database, or book) fhir:Citation.citedArtifact.publicationForm.publishedIn.identifier [ Identifier ], ... ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN fhir:Citation.citedArtifact.publicationForm.publishedIn.title [ string ]; # 0..1 Name of the database or title of the book or journal fhir:Citation.citedArtifact.publicationForm.publishedIn.publisher [ Reference(Organization) ]; # 0..1 Name of the publisher fhir:Citation.citedArtifact.publicationForm.publishedIn.publisherLocation [ string ]; # 0..1 Geographic location of the publisher ];fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ]; ];fhir:Citation.citedArtifact.publicationForm.citedMedium [ CodeableConcept ]; # 0..1 Internet or Print fhir:Citation.citedArtifact.publicationForm.volume [ string ]; # 0..1 Volume number of journal in which the article is published fhir:Citation.citedArtifact.publicationForm.issue [ string ]; # 0..1 Issue, part or supplement of journal in which the article is published fhir:Citation.citedArtifact.publicationForm.publicationDateYear [ string ]; # 0..1 Year on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateMonth [ string ]; # 0..1 Month on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateDay [ string ]; # 0..1 Day on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateSeason [ string ]; # 0..1 Season on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateText [ string ]; # 0..1 Text representation of the date of which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.articleDate [ dateTime ]; # 0..1 The date the article was added to the database, or the date the article was released fhir:Citation.citedArtifact.publicationForm.lastRevisionDate [ dateTime ]; # 0..1 The date the article was last revised or updated in the database fhir:Citation.citedArtifact.publicationForm.language [ CodeableConcept ], ... ; # 0..* Language in which this form of the article is published fhir:Citation.citedArtifact.publicationForm.accessionNumber [ string ]; # 0..1 Entry number or identifier for inclusion in a database fhir:Citation.citedArtifact.publicationForm.pageString [ string ]; # 0..1 Used for full display of pagination fhir:Citation.citedArtifact.publicationForm.firstPage [ string ]; # 0..1 Used for isolated representation of first page fhir:Citation.citedArtifact.publicationForm.lastPage [ string ]; # 0..1 Used for isolated representation of last page fhir:Citation.citedArtifact.publicationForm.pageCount [ string ]; # 0..1 Number of pages or screens fhir:Citation.citedArtifact.publicationForm.copyright [ markdown ]; # 0..1 Copyright notice for the full article or artifact ], ...; fhir:Citation.citedArtifact.webLocation [ # 0..* Used for any URL for the article or artifact citedfhir:fhir:Citation.citedArtifact.webLocation.classifier [ CodeableConcept ], ... ; # 0..* Code the reason for different URLs, e.g. abstract and full-text fhir:Citation.citedArtifact.webLocation.url [ uri ]; # 0..1 The specific URL ], ...; fhir:Citation.citedArtifact.classification [ # 0..* The assignment to an organizing scheme fhir:Citation.citedArtifact.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword) fhir:Citation.citedArtifact.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification valuefhir: fhir: fhir: fhir: fhir: fhir: ];fhir:Citation.citedArtifact.classification.artifactAssessment [ Reference(ArtifactAssessment) ], ... ; # 0..* Complex or externally created classification ], ...; fhir:Citation.citedArtifact.contributorship [ # 0..1 Attribution of authors and other contributors fhir:Citation.citedArtifact.contributorship.complete [ boolean ]; # 0..1 Indicates if the list includes all authors and/or contributors fhir:Citation.citedArtifact.contributorship.entry [ # 0..* An individual entity named in the listfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir:fhir:Citation.citedArtifact.contributorship.entry.contributor [ Reference(Organization|Practitioner) ]; # 1..1 The identity of the individual entity fhir:Citation.citedArtifact.contributorship.entry.forenameInitials [ string ]; # 0..1 Initials for forename fhir:Citation.citedArtifact.contributorship.entry.affiliation [ Reference(Organization|PractitionerRole) ], ... ; # 0..* Organizational affiliation fhir:Citation.citedArtifact.contributorship.entry.contributionType [ CodeableConcept ], ... ; # 0..* The specific contribution fhir:Citation.citedArtifact.contributorship.entry.role [ CodeableConcept ]; # 0..1 The role of the contributor (e.g. author, editor, reviewer) fhir:Citation.citedArtifact.contributorship.entry.contributionInstance [ # 0..* Contributions with accounting for time or number fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.type [ CodeableConcept ]; # 1..1 The specific contribution fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.time [ dateTime ]; # 0..1 The time that the contribution was made ], ...; fhir:Citation.citedArtifact.contributorship.entry.correspondingContact [ boolean ]; # 0..1 Indication of which contributor is the corresponding contributor for the rolefhir:fhir:Citation.citedArtifact.contributorship.entry.rankingOrder [ positiveInt ]; # 0..1 Ranked order of contribution ], ...; fhir:Citation.citedArtifact.contributorship.summary [ # 0..* Used to record a display of the author/contributor list without separate coding for each list member fhir:Citation.citedArtifact.contributorship.summary.type [ CodeableConcept ]; # 0..1 Either authorList or contributorshipStatement fhir:Citation.citedArtifact.contributorship.summary.style [ CodeableConcept ]; # 0..1 The format for the display string fhir:Citation.citedArtifact.contributorship.summary.source [ CodeableConcept ]; # 0..1 Used to code the producer or rule for creating the display string fhir:Citation.citedArtifact.contributorship.summary.value [ markdown ]; # 1..1 The display string for the author list, contributor list, or contributorship statement ], ...; ]; fhir:Citation.citedArtifact.note [ Annotation ], ... ; # 0..* Any additional information or content for the article or artifact ]; ]
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
Citation
|
TU | DomainResource |
A
description
of
identification,
location,
or
contributorship
of
a
publication
(article
or
artifact)
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension Interfaces Implemented: MetadataResource |
|
|
url
|
Σ C | 0..1 | uri |
Canonical
identifier
for
this
citation,
represented
as
a
globally
unique
URI
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
|
identifier
|
Σ | 0..* | Identifier |
Identifier
for
the
Citation
resource
itself
|
|
version
|
Σ | 0..1 | string |
Business
version
of
the
citation
|
|
name
|
Σ
|
0..1 | string |
Name
for
this
citation
(computer
friendly)
|
|
title
|
Σ | 0..1 | string |
Name
for
this
citation
(human
friendly)
|
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
|
experimental
|
Σ | 0..1 | boolean |
For
testing
purposes,
not
real
usage
|
|
date
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
publisher
|
Σ | 0..1 | string |
The
publisher
of
the
Citation,
not
the
publisher
of
the
article
or
artifact
being
cited
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
of
the
Citation
Resource
|
|
description
|
0..1 | markdown |
Natural
language
description
of
the
citation
|
|
|
useContext
|
Σ | 0..* | UsageContext |
The
context
that
the
Citation
Resource
content
is
intended
to
support
|
|
jurisdiction
|
Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
citation
(if
applicable)
Jurisdiction ( Extensible ) |
|
purpose
|
0..1 | markdown |
Why
this
citation
is
defined
|
|
|
copyright
|
0..1 | markdown |
Use
and/or
publishing
restrictions
for
the
Citation,
not
for
the
cited
artifact
|
|
|
approvalDate
|
0..1 | date |
When
the
citation
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
When
the
citation
was
last
reviewed
|
|
|
effectivePeriod
|
Σ | 0..1 | Period |
When
the
citation
is
expected
to
be
used
|
|
author
|
0..* | ContactDetail |
Who
authored
the
Citation
|
|
|
editor
|
0..* | ContactDetail |
Who
edited
the
Citation
|
|
|
reviewer
|
0..* | ContactDetail |
Who
reviewed
the
Citation
|
|
|
endorser
|
0..* | ContactDetail |
Who
endorsed
the
Citation
|
|
|
summary
|
0..* | BackboneElement |
A
human-readable
display
of
the
citation
|
|
|
style
|
0..1 | CodeableConcept |
Format
for
display
of
the
citation
CitationSummaryStyle ( Extensible ) |
|
|
text
|
Σ | 1..1 | markdown |
The
human-readable
display
of
the
citation
|
|
classification
|
0..* | BackboneElement |
The
assignment
to
an
organizing
scheme
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
classifier
(e.g.
publication
type,
keyword)
CitationClassificationType ( Extensible ) |
|
|
classifier
|
0..* | CodeableConcept |
The
specific
classification
value
CitationArtifactClassifier ( Example ) |
|
|
note
|
0..* | Annotation |
Used
for
general
notes
and
annotations
not
coded
elsewhere
|
|
|
currentState
|
0..* | CodeableConcept |
The
status
of
the
citation
CitationStatusType ( Example ) |
|
|
statusDate
|
0..* | BackboneElement |
An
effective
date
or
period
for
a
status
of
the
citation
|
|
|
activity
|
1..1 | CodeableConcept |
Classification
of
the
status
CitationStatusType ( Example ) |
|
|
actual
|
0..1 | boolean |
Either
occurred
or
expected
|
|
|
period
|
1..1 | Period |
When
the
status
started
and/or
ended
|
|
|
relatedArtifact
|
0..* |
|
Artifact
related
to
the
Citation
Resource
|
|
|
citedArtifact
|
0..1 | BackboneElement |
The
article
or
artifact
being
described
|
|
|
identifier
|
Σ | 0..* | Identifier |
May
include
DOI,
PMID,
PMCID,
etc.
|
|
relatedIdentifier
|
Σ | 0..* | Identifier |
May
include
trial
registry
identifiers
|
|
dateAccessed
|
Σ | 0..1 | dateTime |
When
the
cited
artifact
was
accessed
|
|
version
|
0..1 | BackboneElement |
The
defined
version
of
the
cited
artifact
|
|
|
value
|
1..1 | string |
The
version
number
or
other
version
identifier
|
|
|
baseCitation
|
0..1 | Reference ( Citation ) |
Citation
for
the
main
version
of
the
cited
artifact
|
|
|
currentState
|
0..* | CodeableConcept |
The
status
of
the
cited
artifact
CitedArtifactStatusType ( Extensible ) |
|
|
statusDate
|
0..* | BackboneElement |
An
effective
date
or
period
for
a
status
of
the
cited
artifact
|
|
|
activity
|
1..1 | CodeableConcept |
Classification
of
the
status
CitedArtifactStatusType ( Extensible ) |
|
|
actual
|
0..1 | boolean |
Either
occurred
or
expected
|
|
|
period
|
1..1 | Period |
When
the
status
started
and/or
ended
|
|
|
title
|
0..* | BackboneElement |
The
title
details
of
the
article
or
artifact
|
|
|
type
|
0..* | CodeableConcept |
The
kind
of
title
TitleType ( Extensible ) |
|
|
language
|
0..1 | CodeableConcept |
Used
to
express
the
specific
language
Common Languages ( Preferred ) |
|
|
text
|
1..1 | markdown |
The
title
of
the
article
or
artifact
|
|
|
abstract
|
0..* | BackboneElement |
Summary
of
the
article
or
artifact
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
abstract
CitedArtifactAbstractType ( Extensible ) |
|
|
language
|
0..1 | CodeableConcept |
Used
to
express
the
specific
language
Common Languages ( Preferred ) |
|
|
text
|
1..1 | markdown |
Abstract
content
|
|
|
copyright
|
0..1 | markdown |
Copyright
notice
for
the
abstract
|
|
|
part
|
0..1 | BackboneElement |
The
component
of
the
article
or
artifact
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
component
CitedArtifactPartType ( Extensible ) |
|
|
value
|
0..1 | string |
The
specification
of
the
component
|
|
|
baseCitation
|
0..1 | Reference ( Citation ) |
The
citation
for
the
full
article
or
artifact
|
|
|
relatesTo
|
0..* | BackboneElement |
The
artifact
related
to
the
cited
artifact
|
|
|
type
| 1..1 | code |
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
|
reprint
|
reprint-of
RelatedArtifactTypeExpanded ( Required ) | |
|
|
|
CodeableConcept |
|
|
|
label
|
|
|
|
|
|
display
|
|
string |
|
|
|
|
0..1 |
|
Bibliographic
citation
for
the
artifact
|
|
|
|
0..1 |
|
What
document
is
being
referenced
|
|
|
|
0..1 |
|
What
artifact
is
being
referenced
|
|
|
resourceReference
|
0..1 |
|
What
artifact,
if
not
a
conformance
resource
|
|
|
publicationForm
|
0..* | BackboneElement |
If
multiple,
used
to
represent
alternative
forms
of
the
article
that
are
not
separate
citations
|
|
|
publishedIn
|
0..1 | BackboneElement |
The
collection
the
cited
article
or
artifact
is
published
in
|
|
|
type
|
0..1 | CodeableConcept |
Kind
of
container
(e.g.
Periodical,
database,
or
book)
PublishedInType ( Extensible ) |
|
|
identifier
|
0..* | Identifier |
Journal
identifiers
include
ISSN,
ISO
Abbreviation
and
NLMuniqueID;
Book
identifiers
include
ISBN
|
|
|
title
|
0..1 | string |
Name
of
the
database
or
title
of
the
book
or
journal
|
|
|
publisher
|
0..1 | Reference ( Organization ) |
Name
of
the
publisher
|
|
|
publisherLocation
|
0..1 | string |
Geographic
location
of
the
publisher
|
|
|
citedMedium
|
0..1 |
|
Internet
or
Print
CitedMedium ( Extensible ) |
|
|
volume
|
0..1 | string |
Volume
number
of
journal
in
which
the
article
is
published
|
|
|
issue
|
0..1 | string |
Issue,
part
or
supplement
of
journal
in
which
the
article
is
published
|
|
|
|
0..1 |
|
|
|
|
|
0..1 | string |
|
|
|
|
0..1 | string |
|
|
|
|
0..1 | string |
|
|
|
|
0..1 | string |
|
|
|
articleDate
|
0..1 | dateTime |
The
date
the
article
was
added
to
the
database,
or
the
date
the
article
was
released
|
|
|
lastRevisionDate
|
0..1 | dateTime |
The
date
the
article
was
last
revised
or
updated
in
the
database
|
|
|
language
|
0..* | CodeableConcept |
Language
in
which
this
form
of
the
article
is
published
Common Languages ( Preferred ) |
|
|
accessionNumber
|
0..1 | string |
Entry
number
or
identifier
for
inclusion
in
a
database
|
|
|
pageString
|
0..1 | string |
Used
for
full
display
of
pagination
|
|
|
firstPage
|
0..1 | string |
Used
for
isolated
representation
of
first
page
|
|
|
lastPage
|
0..1 | string |
Used
for
isolated
representation
of
last
page
|
|
|
pageCount
|
0..1 | string |
Number
of
pages
or
screens
|
|
|
copyright
|
0..1 | markdown |
Copyright
notice
for
the
full
article
or
artifact
|
|
|
webLocation
|
0..* | BackboneElement |
Used
for
any
URL
for
the
article
or
artifact
cited
|
|
|
classifier
|
0..* | CodeableConcept |
Code
the
reason
for
different
URLs,
e.g.
abstract
and
full-text
|
|
|
url
|
0..1 | uri |
The
specific
URL
|
|
|
classification
|
0..* | BackboneElement |
The
assignment
to
an
organizing
scheme
|
|
|
type
|
0..1 | CodeableConcept |
The
kind
of
classifier
(e.g.
publication
type,
keyword)
CitedArtifactClassificationType ( Extensible ) |
|
|
classifier
|
0..* | CodeableConcept |
The
specific
classification
value
CitationArtifactClassifier ( Example ) |
|
|
|
|
Reference
(
|
|
|
|
contributorship
|
0..1 | BackboneElement |
Attribution
of
authors
and
other
contributors
|
|
|
complete
|
0..1 | boolean |
Indicates
if
the
list
includes
all
authors
and/or
contributors
|
|
|
entry
|
0..* | BackboneElement |
An
individual
entity
named
in
the
list
|
|
|
contributor
|
|
|
|
|
|
|
0..1 | string |
Initials
for
forename
|
|
|
affiliation
|
|
|
Organizational
affiliation
|
|
|
|
0..* | CodeableConcept |
The
specific
contribution
ArtifactContributionType ( Extensible ) |
|
|
role
|
0..1 | CodeableConcept |
The
role
of
the
contributor
(e.g.
author,
editor,
reviewer)
ContributorRole ( Extensible ) |
|
|
contributionInstance
|
0..* | BackboneElement |
Contributions
with
accounting
for
time
or
number
|
|
|
type
|
1..1 | CodeableConcept |
The
specific
contribution
ArtifactContributionInstanceType ( Extensible ) |
|
|
time
|
0..1 | dateTime |
The
time
that
the
contribution
was
made
|
|
|
correspondingContact
|
0..1 | boolean |
Indication
of
which
contributor
is
the
corresponding
contributor
for
the
role
|
|
|
rankingOrder
|
0..1 | positiveInt |
Ranked
order
of
|
|
|
summary
|
0..* | BackboneElement |
Used
to
record
a
display
of
the
author/contributor
list
without
separate
coding
for
each
list
member
|
|
|
type
|
0..1 | CodeableConcept |
Either
authorList
or
contributorshipStatement
ContributorSummaryType ( Extensible ) |
|
|
style
|
0..1 | CodeableConcept |
The
format
for
the
display
string
ContributorSummaryStyle ( Extensible ) |
|
|
source
|
0..1 | CodeableConcept |
Used
to
code
the
producer
or
rule
for
creating
the
display
string
ContributorSummarySource ( Extensible ) |
|
|
value
|
1..1 | markdown |
The
display
string
for
the
author
list,
contributor
list,
or
contributorship
statement
|
|
|
note
|
0..* | Annotation |
Any
additional
information
or
content
for
the
article
or
artifact
|
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<Citation xmlns="http://hl7.org/fhir"><<url value="[uri]"/><!-- 0..1 Canonical identifier for this citation, represented as a globally unique URI --> <identifier><!-- 0..* Identifier Identifier for the Citation resource itself --></identifier> <version value="[string]"/><!-- 0..1 Business version of the citation --><<name value="[string]"/><!-- I 0..1 Name for this citation (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this citation (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited --> <contact><!-- 0..* ContactDetail Contact details for the publisher of the Citation Resource --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the citation --> <useContext><!-- 0..* UsageContext The context that the Citation Resource content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for citation (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this citation is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact --> <approvalDate value="[date]"/><!-- 0..1 When the citation was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the citation was last reviewed --> <effectivePeriod><!-- 0..1 Period When the citation is expected to be used --></effectivePeriod> <author><!-- 0..* ContactDetail Who authored the Citation --></author> <editor><!-- 0..* ContactDetail Who edited the Citation --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the Citation --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the Citation --></endorser> <summary> <!-- 0..* A human-readable display of the citation --> <style><!-- 0..1 CodeableConcept Format for display of the citation --></style> <text value="[markdown]"/><!-- 1..1 The human-readable display of the citation --> </summary> <classification> <!-- 0..* The assignment to an organizing scheme --> <type><!-- 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword) --></type> <classifier><!-- 0..* CodeableConcept The specific classification value --></classifier> </classification> <note><!-- 0..* Annotation Used for general notes and annotations not coded elsewhere --></note> <currentState><!-- 0..* CodeableConcept The status of the citation --></currentState> <statusDate> <!-- 0..* An effective date or period for a status of the citation --> <activity><!-- 1..1 CodeableConcept Classification of the status --></activity> <actual value="[boolean]"/><!-- 0..1 Either occurred or expected --> <period><!-- 1..1 Period When the status started and/or ended --></period> </statusDate>< <</relationshipType> <</targetClassifier> <</target[x]> </relatesTo><relatedArtifact><!-- 0..* RelatedArtifact Artifact related to the Citation Resource --></relatedArtifact> <citedArtifact> <!-- 0..1 The article or artifact being described --> <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier> <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier> <dateAccessed value="[dateTime]"/><!-- 0..1 When the cited artifact was accessed --> <version> <!-- 0..1 The defined version of the cited artifact --> <value value="[string]"/><!-- 1..1 The version number or other version identifier --> <baseCitation><!-- 0..1 Reference(Citation) Citation for the main version of the cited artifact --></baseCitation> </version> <currentState><!-- 0..* CodeableConcept The status of the cited artifact --></currentState> <statusDate> <!-- 0..* An effective date or period for a status of the cited artifact --> <activity><!-- 1..1 CodeableConcept Classification of the status --></activity> <actual value="[boolean]"/><!-- 0..1 Either occurred or expected --> <period><!-- 1..1 Period When the status started and/or ended --></period> </statusDate> <title> <!-- 0..* The title details of the article or artifact --> <type><!-- 0..* CodeableConcept The kind of title --></type> <language><!-- 0..1 CodeableConcept Used to express the specific language --></language> <text value="[markdown]"/><!-- 1..1 The title of the article or artifact --> </title> <abstract> <!-- 0..* Summary of the article or artifact --> <type><!-- 0..1 CodeableConcept The kind of abstract --></type> <language><!-- 0..1 CodeableConcept Used to express the specific language --></language> <text value="[markdown]"/><!-- 1..1 Abstract content --> <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the abstract --> </abstract> <part> <!-- 0..1 The component of the article or artifact --> <type><!-- 0..1 CodeableConcept The kind of component --></type> <value value="[string]"/><!-- 0..1 The specification of the component --> <baseCitation><!-- 0..1 Reference(Citation) The citation for the full article or artifact --></baseCitation> </part> <relatesTo> <!-- 0..* The artifact related to the cited artifact --><</relationshipType> <</targetClassifier> <</target[x]><type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of --> <classifier><!-- 0..* CodeableConcept Additional classifiers --></classifier> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource value="[canonical]"/><!-- 0..1 What artifact is being referenced --> <resourceReference><!-- 0..1 Reference What artifact, if not a conformance resource --></resourceReference> </relatesTo> <publicationForm> <!-- 0..* If multiple, used to represent alternative forms of the article that are not separate citations --> <publishedIn> <!-- 0..1 The collection the cited article or artifact is published in --> <type><!-- 0..1 CodeableConcept Kind of container (e.g. Periodical, database, or book) --></type> <identifier><!-- 0..* Identifier Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN --></identifier> <title value="[string]"/><!-- 0..1 Name of the database or title of the book or journal --> <publisher><!-- 0..1 Reference(Organization) Name of the publisher --></publisher> <publisherLocation value="[string]"/><!-- 0..1 Geographic location of the publisher --> </publishedIn>< <</citedMedium> < < < < < < < < < </dateOfPublication> </periodicRelease><citedMedium><!-- 0..1 CodeableConcept Internet or Print --></citedMedium> <volume value="[string]"/><!-- 0..1 Volume number of journal in which the article is published --> <issue value="[string]"/><!-- 0..1 Issue, part or supplement of journal in which the article is published --> <publicationDateYear value="[string]"/><!-- 0..1 Year on which the issue of the journal was published --> <publicationDateMonth value="[string]"/><!-- 0..1 Month on which the issue of the journal was published --> <publicationDateDay value="[string]"/><!-- 0..1 Day on which the issue of the journal was published --> <publicationDateSeason value="[string]"/><!-- 0..1 Season on which the issue of the journal was published --> <publicationDateText value="[string]"/><!-- 0..1 Text representation of the date of which the issue of the journal was published --> <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released --> <lastRevisionDate value="[dateTime]"/><!-- 0..1 The date the article was last revised or updated in the database --> <language><!-- 0..* CodeableConcept Language in which this form of the article is published --></language> <accessionNumber value="[string]"/><!-- 0..1 Entry number or identifier for inclusion in a database --> <pageString value="[string]"/><!-- 0..1 Used for full display of pagination --> <firstPage value="[string]"/><!-- 0..1 Used for isolated representation of first page --> <lastPage value="[string]"/><!-- 0..1 Used for isolated representation of last page --> <pageCount value="[string]"/><!-- 0..1 Number of pages or screens --> <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the full article or artifact --> </publicationForm> <webLocation> <!-- 0..* Used for any URL for the article or artifact cited --><</type><classifier><!-- 0..* CodeableConcept Code the reason for different URLs, e.g. abstract and full-text --></classifier> <url value="[uri]"/><!-- 0..1 The specific URL --> </webLocation> <classification> <!-- 0..* The assignment to an organizing scheme --> <type><!-- 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword) --></type> <classifier><!-- 0..* CodeableConcept The specific classification value --></classifier>< <</person> <</organization> <</publisher> < < </whoClassified><artifactAssessment><!-- 0..* Reference(ArtifactAssessment) Complex or externally created classification --></artifactAssessment> </classification> <contributorship> <!-- 0..1 Attribution of authors and other contributors --> <complete value="[boolean]"/><!-- 0..1 Indicates if the list includes all authors and/or contributors --> <entry> <!-- 0..* An individual entity named in the list --><</name> < < <</identifier> < < < <</identifier> </affiliationInfo> <</address> <</telecom><contributor><!-- 1..1 Reference(Organization|Practitioner) The identity of the individual entity --></contributor> <forenameInitials value="[string]"/><!-- 0..1 Initials for forename --> <affiliation><!-- 0..* Reference(Organization|PractitionerRole) Organizational affiliation --></affiliation> <contributionType><!-- 0..* CodeableConcept The specific contribution --></contributionType> <role><!-- 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer) --></role> <contributionInstance> <!-- 0..* Contributions with accounting for time or number --> <type><!-- 1..1 CodeableConcept The specific contribution --></type> <time value="[dateTime]"/><!-- 0..1 The time that the contribution was made --> </contributionInstance> <correspondingContact value="[boolean]"/><!-- 0..1 Indication of which contributor is the corresponding contributor for the role --><<rankingOrder value="[positiveInt]"/><!-- 0..1 Ranked order of contribution --> </entry> <summary> <!-- 0..* Used to record a display of the author/contributor list without separate coding for each list member --> <type><!-- 0..1 CodeableConcept Either authorList or contributorshipStatement --></type> <style><!-- 0..1 CodeableConcept The format for the display string --></style> <source><!-- 0..1 CodeableConcept Used to code the producer or rule for creating the display string --></source> <value value="[markdown]"/><!-- 1..1 The display string for the author list, contributor list, or contributorship statement --> </summary> </contributorship> <note><!-- 0..* Annotation Any additional information or content for the article or artifact --></note> </citedArtifact> </Citation>
JSON Template
{
"resourceType" : "Citation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"
"url" : "<uri>", // Canonical identifier for this citation, represented as a globally unique URI
"identifier" : [{ Identifier }], // Identifier for the Citation resource itself
"version" : "<string>", // Business version of the citation
"
"name" : "<string>", // I Name for this citation (computer friendly)
"title" : "<string>", // Name for this citation (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // The publisher of the Citation, not the publisher of the article or artifact being cited
"contact" : [{ ContactDetail }], // Contact details for the publisher of the Citation Resource
"description" : "<markdown>", // Natural language description of the citation
"useContext" : [{ UsageContext }], // The context that the Citation Resource content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation (if applicable)
"purpose" : "<markdown>", // Why this citation is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions for the Citation, not for the cited artifact
"approvalDate" : "<date>", // When the citation was approved by publisher
"lastReviewDate" : "<date>", // When the citation was last reviewed
"effectivePeriod" : { Period }, // When the citation is expected to be used
"author" : [{ ContactDetail }], // Who authored the Citation
"editor" : [{ ContactDetail }], // Who edited the Citation
"reviewer" : [{ ContactDetail }], // Who reviewed the Citation
"endorser" : [{ ContactDetail }], // Who endorsed the Citation
"summary" : [{ // A human-readable display of the citation
"style" : { CodeableConcept }, // Format for display of the citation
"text" : "<markdown>" // R! The human-readable display of the citation
}],
"classification" : [{ // The assignment to an organizing scheme
"type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
"classifier" : [{ CodeableConcept }] // The specific classification value
}],
"note" : [{ Annotation }], // Used for general notes and annotations not coded elsewhere
"currentState" : [{ CodeableConcept }], // The status of the citation
"statusDate" : [{ // An effective date or period for a status of the citation
"activity" : { CodeableConcept }, // R! Classification of the status
"actual" : <boolean>, // Either occurred or expected
"period" : { Period } // R! When the status started and/or ended
}],
"
"
"
">"
" }
" }
" }
}],
"relatedArtifact" : [{ RelatedArtifact }], // Artifact related to the Citation Resource
"citedArtifact" : { // The article or artifact being described
"identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc.
"relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers
"dateAccessed" : "<dateTime>", // When the cited artifact was accessed
"version" : { // The defined version of the cited artifact
"value" : "<string>", // R! The version number or other version identifier
"baseCitation" : { Reference(Citation) } // Citation for the main version of the cited artifact
},
"currentState" : [{ CodeableConcept }], // The status of the cited artifact
"statusDate" : [{ // An effective date or period for a status of the cited artifact
"activity" : { CodeableConcept }, // R! Classification of the status
"actual" : <boolean>, // Either occurred or expected
"period" : { Period } // R! When the status started and/or ended
}],
"title" : [{ // The title details of the article or artifact
"type" : [{ CodeableConcept }], // The kind of title
"language" : { CodeableConcept }, // Used to express the specific language
"text" : "<markdown>" // R! The title of the article or artifact
}],
"abstract" : [{ // Summary of the article or artifact
"type" : { CodeableConcept }, // The kind of abstract
"language" : { CodeableConcept }, // Used to express the specific language
"text" : "<markdown>", // R! Abstract content
"copyright" : "<markdown>" // Copyright notice for the abstract
}],
"part" : { // The component of the article or artifact
"type" : { CodeableConcept }, // The kind of component
"value" : "<string>", // The specification of the component
"baseCitation" : { Reference(Citation) } // The citation for the full article or artifact
},
"relatesTo" : [{ // The artifact related to the cited artifact
"
"
">"
" }
" }
" }
"type" : "<code>", // R! documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
"classifier" : [{ CodeableConcept }], // Additional classifiers
"label" : "<string>", // Short label
"display" : "<string>", // Brief description of the related artifact
"citation" : "<markdown>", // Bibliographic citation for the artifact
"document" : { Attachment }, // What document is being referenced
"resource" : "<canonical>", // What artifact is being referenced
"resourceReference" : { Reference } // What artifact, if not a conformance resource
}],
"publicationForm" : [{ // If multiple, used to represent alternative forms of the article that are not separate citations
"publishedIn" : { // The collection the cited article or artifact is published in
"type" : { CodeableConcept }, // Kind of container (e.g. Periodical, database, or book)
"identifier" : [{ Identifier }], // Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
"title" : "<string>", // Name of the database or title of the book or journal
"publisher" : { Reference(Organization) }, // Name of the publisher
"publisherLocation" : "<string>" // Geographic location of the publisher
},
"
"
"
"
"
"
"
"
"
"
"
}
},
"citedMedium" : { CodeableConcept }, // Internet or Print
"volume" : "<string>", // Volume number of journal in which the article is published
"issue" : "<string>", // Issue, part or supplement of journal in which the article is published
"publicationDateYear" : "<string>", // Year on which the issue of the journal was published
"publicationDateMonth" : "<string>", // Month on which the issue of the journal was published
"publicationDateDay" : "<string>", // Day on which the issue of the journal was published
"publicationDateSeason" : "<string>", // Season on which the issue of the journal was published
"publicationDateText" : "<string>", // Text representation of the date of which the issue of the journal was published
"articleDate" : "<dateTime>", // The date the article was added to the database, or the date the article was released
"lastRevisionDate" : "<dateTime>", // The date the article was last revised or updated in the database
"language" : [{ CodeableConcept }], // Language in which this form of the article is published
"accessionNumber" : "<string>", // Entry number or identifier for inclusion in a database
"pageString" : "<string>", // Used for full display of pagination
"firstPage" : "<string>", // Used for isolated representation of first page
"lastPage" : "<string>", // Used for isolated representation of last page
"pageCount" : "<string>", // Number of pages or screens
"copyright" : "<markdown>" // Copyright notice for the full article or artifact
}],
"webLocation" : [{ // Used for any URL for the article or artifact cited
"
"classifier" : [{ CodeableConcept }], // Code the reason for different URLs, e.g. abstract and full-text
"url" : "<uri>" // The specific URL
}],
"classification" : [{ // The assignment to an organizing scheme
"type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
"classifier" : [{ CodeableConcept }], // The specific classification value
"
"
"
"
"
"
}
"artifactAssessment" : [{ Reference(ArtifactAssessment) }] // Complex or externally created classification
}],
"contributorship" : { // Attribution of authors and other contributors
"complete" : <boolean>, // Indicates if the list includes all authors and/or contributors
"entry" : [{ // An individual entity named in the list
"
"
"
"
"
"
"
"
}],
"
"
"contributor" : { Reference(Organization|Practitioner) }, // R! The identity of the individual entity
"forenameInitials" : "<string>", // Initials for forename
"affiliation" : [{ Reference(Organization|PractitionerRole) }], // Organizational affiliation
"contributionType" : [{ CodeableConcept }], // The specific contribution
"role" : { CodeableConcept }, // The role of the contributor (e.g. author, editor, reviewer)
"contributionInstance" : [{ // Contributions with accounting for time or number
"type" : { CodeableConcept }, // R! The specific contribution
"time" : "<dateTime>" // The time that the contribution was made
}],
"correspondingContact" : <boolean>, // Indication of which contributor is the corresponding contributor for the role
"
"rankingOrder" : "<positiveInt>" // Ranked order of contribution
}],
"summary" : [{ // Used to record a display of the author/contributor list without separate coding for each list member
"type" : { CodeableConcept }, // Either authorList or contributorshipStatement
"style" : { CodeableConcept }, // The format for the display string
"source" : { CodeableConcept }, // Used to code the producer or rule for creating the display string
"value" : "<markdown>" // R! The display string for the author list, contributor list, or contributorship statement
}]
},
"note" : [{ Annotation }] // Any additional information or content for the article or artifact
}
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .fhir:fhir:Citation.url [ uri ]; # 0..1 Canonical identifier for this citation, represented as a globally unique URI fhir:Citation.identifier [ Identifier ], ... ; # 0..* Identifier for the Citation resource itself fhir:Citation.version [ string ]; # 0..1 Business version of the citationfhir:fhir:Citation.name [ string ]; # 0..1 I Name for this citation (computer friendly) fhir:Citation.title [ string ]; # 0..1 Name for this citation (human friendly) fhir:Citation.status [ code ]; # 1..1 draft | active | retired | unknown fhir:Citation.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:Citation.date [ dateTime ]; # 0..1 Date last changed fhir:Citation.publisher [ string ]; # 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited fhir:Citation.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher of the Citation Resource fhir:Citation.description [ markdown ]; # 0..1 Natural language description of the citation fhir:Citation.useContext [ UsageContext ], ... ; # 0..* The context that the Citation Resource content is intended to support fhir:Citation.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for citation (if applicable) fhir:Citation.purpose [ markdown ]; # 0..1 Why this citation is defined fhir:Citation.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact fhir:Citation.approvalDate [ date ]; # 0..1 When the citation was approved by publisher fhir:Citation.lastReviewDate [ date ]; # 0..1 When the citation was last reviewed fhir:Citation.effectivePeriod [ Period ]; # 0..1 When the citation is expected to be used fhir:Citation.author [ ContactDetail ], ... ; # 0..* Who authored the Citation fhir:Citation.editor [ ContactDetail ], ... ; # 0..* Who edited the Citation fhir:Citation.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the Citation fhir:Citation.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the Citation fhir:Citation.summary [ # 0..* A human-readable display of the citation fhir:Citation.summary.style [ CodeableConcept ]; # 0..1 Format for display of the citation fhir:Citation.summary.text [ markdown ]; # 1..1 The human-readable display of the citation ], ...; fhir:Citation.classification [ # 0..* The assignment to an organizing scheme fhir:Citation.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword) fhir:Citation.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification value ], ...; fhir:Citation.note [ Annotation ], ... ; # 0..* Used for general notes and annotations not coded elsewhere fhir:Citation.currentState [ CodeableConcept ], ... ; # 0..* The status of the citation fhir:Citation.statusDate [ # 0..* An effective date or period for a status of the citation fhir:Citation.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status fhir:Citation.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected fhir:Citation.statusDate.period [ Period ]; # 1..1 When the status started and/or ended ], ...;fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir:) ] fhir: ] ], ...;fhir:Citation.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Artifact related to the Citation Resource fhir:Citation.citedArtifact [ # 0..1 The article or artifact being described fhir:Citation.citedArtifact.identifier [ Identifier ], ... ; # 0..* May include DOI, PMID, PMCID, etc. fhir:Citation.citedArtifact.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers fhir:Citation.citedArtifact.dateAccessed [ dateTime ]; # 0..1 When the cited artifact was accessed fhir:Citation.citedArtifact.version [ # 0..1 The defined version of the cited artifact fhir:Citation.citedArtifact.version.value [ string ]; # 1..1 The version number or other version identifier fhir:Citation.citedArtifact.version.baseCitation [ Reference(Citation) ]; # 0..1 Citation for the main version of the cited artifact ]; fhir:Citation.citedArtifact.currentState [ CodeableConcept ], ... ; # 0..* The status of the cited artifact fhir:Citation.citedArtifact.statusDate [ # 0..* An effective date or period for a status of the cited artifact fhir:Citation.citedArtifact.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status fhir:Citation.citedArtifact.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected fhir:Citation.citedArtifact.statusDate.period [ Period ]; # 1..1 When the status started and/or ended ], ...; fhir:Citation.citedArtifact.title [ # 0..* The title details of the article or artifact fhir:Citation.citedArtifact.title.type [ CodeableConcept ], ... ; # 0..* The kind of title fhir:Citation.citedArtifact.title.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.citedArtifact.title.text [ markdown ]; # 1..1 The title of the article or artifact ], ...; fhir:Citation.citedArtifact.abstract [ # 0..* Summary of the article or artifact fhir:Citation.citedArtifact.abstract.type [ CodeableConcept ]; # 0..1 The kind of abstract fhir:Citation.citedArtifact.abstract.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.citedArtifact.abstract.text [ markdown ]; # 1..1 Abstract content fhir:Citation.citedArtifact.abstract.copyright [ markdown ]; # 0..1 Copyright notice for the abstract ], ...; fhir:Citation.citedArtifact.part [ # 0..1 The component of the article or artifact fhir:Citation.citedArtifact.part.type [ CodeableConcept ]; # 0..1 The kind of component fhir:Citation.citedArtifact.part.value [ string ]; # 0..1 The specification of the component fhir:Citation.citedArtifact.part.baseCitation [ Reference(Citation) ]; # 0..1 The citation for the full article or artifact ]; fhir:Citation.citedArtifact.relatesTo [ # 0..* The artifact related to the cited artifactfhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir:) ] fhir: ]fhir:Citation.citedArtifact.relatesTo.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of fhir:Citation.citedArtifact.relatesTo.classifier [ CodeableConcept ], ... ; # 0..* Additional classifiers fhir:Citation.citedArtifact.relatesTo.label [ string ]; # 0..1 Short label fhir:Citation.citedArtifact.relatesTo.display [ string ]; # 0..1 Brief description of the related artifact fhir:Citation.citedArtifact.relatesTo.citation [ markdown ]; # 0..1 Bibliographic citation for the artifact fhir:Citation.citedArtifact.relatesTo.document [ Attachment ]; # 0..1 What document is being referenced fhir:Citation.citedArtifact.relatesTo.resource [ canonical ]; # 0..1 What artifact is being referenced fhir:Citation.citedArtifact.relatesTo.resourceReference [ Reference ]; # 0..1 What artifact, if not a conformance resource ], ...; fhir:Citation.citedArtifact.publicationForm [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations fhir:Citation.citedArtifact.publicationForm.publishedIn [ # 0..1 The collection the cited article or artifact is published in fhir:Citation.citedArtifact.publicationForm.publishedIn.type [ CodeableConcept ]; # 0..1 Kind of container (e.g. Periodical, database, or book) fhir:Citation.citedArtifact.publicationForm.publishedIn.identifier [ Identifier ], ... ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN fhir:Citation.citedArtifact.publicationForm.publishedIn.title [ string ]; # 0..1 Name of the database or title of the book or journal fhir:Citation.citedArtifact.publicationForm.publishedIn.publisher [ Reference(Organization) ]; # 0..1 Name of the publisher fhir:Citation.citedArtifact.publicationForm.publishedIn.publisherLocation [ string ]; # 0..1 Geographic location of the publisher ];fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ]; ];fhir:Citation.citedArtifact.publicationForm.citedMedium [ CodeableConcept ]; # 0..1 Internet or Print fhir:Citation.citedArtifact.publicationForm.volume [ string ]; # 0..1 Volume number of journal in which the article is published fhir:Citation.citedArtifact.publicationForm.issue [ string ]; # 0..1 Issue, part or supplement of journal in which the article is published fhir:Citation.citedArtifact.publicationForm.publicationDateYear [ string ]; # 0..1 Year on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateMonth [ string ]; # 0..1 Month on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateDay [ string ]; # 0..1 Day on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateSeason [ string ]; # 0..1 Season on which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.publicationDateText [ string ]; # 0..1 Text representation of the date of which the issue of the journal was published fhir:Citation.citedArtifact.publicationForm.articleDate [ dateTime ]; # 0..1 The date the article was added to the database, or the date the article was released fhir:Citation.citedArtifact.publicationForm.lastRevisionDate [ dateTime ]; # 0..1 The date the article was last revised or updated in the database fhir:Citation.citedArtifact.publicationForm.language [ CodeableConcept ], ... ; # 0..* Language in which this form of the article is published fhir:Citation.citedArtifact.publicationForm.accessionNumber [ string ]; # 0..1 Entry number or identifier for inclusion in a database fhir:Citation.citedArtifact.publicationForm.pageString [ string ]; # 0..1 Used for full display of pagination fhir:Citation.citedArtifact.publicationForm.firstPage [ string ]; # 0..1 Used for isolated representation of first page fhir:Citation.citedArtifact.publicationForm.lastPage [ string ]; # 0..1 Used for isolated representation of last page fhir:Citation.citedArtifact.publicationForm.pageCount [ string ]; # 0..1 Number of pages or screens fhir:Citation.citedArtifact.publicationForm.copyright [ markdown ]; # 0..1 Copyright notice for the full article or artifact ], ...; fhir:Citation.citedArtifact.webLocation [ # 0..* Used for any URL for the article or artifact citedfhir:fhir:Citation.citedArtifact.webLocation.classifier [ CodeableConcept ], ... ; # 0..* Code the reason for different URLs, e.g. abstract and full-text fhir:Citation.citedArtifact.webLocation.url [ uri ]; # 0..1 The specific URL ], ...; fhir:Citation.citedArtifact.classification [ # 0..* The assignment to an organizing scheme fhir:Citation.citedArtifact.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword) fhir:Citation.citedArtifact.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification valuefhir: fhir: fhir: fhir: fhir: fhir: ];fhir:Citation.citedArtifact.classification.artifactAssessment [ Reference(ArtifactAssessment) ], ... ; # 0..* Complex or externally created classification ], ...; fhir:Citation.citedArtifact.contributorship [ # 0..1 Attribution of authors and other contributors fhir:Citation.citedArtifact.contributorship.complete [ boolean ]; # 0..1 Indicates if the list includes all authors and/or contributors fhir:Citation.citedArtifact.contributorship.entry [ # 0..* An individual entity named in the listfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir:fhir:Citation.citedArtifact.contributorship.entry.contributor [ Reference(Organization|Practitioner) ]; # 1..1 The identity of the individual entity fhir:Citation.citedArtifact.contributorship.entry.forenameInitials [ string ]; # 0..1 Initials for forename fhir:Citation.citedArtifact.contributorship.entry.affiliation [ Reference(Organization|PractitionerRole) ], ... ; # 0..* Organizational affiliation fhir:Citation.citedArtifact.contributorship.entry.contributionType [ CodeableConcept ], ... ; # 0..* The specific contribution fhir:Citation.citedArtifact.contributorship.entry.role [ CodeableConcept ]; # 0..1 The role of the contributor (e.g. author, editor, reviewer) fhir:Citation.citedArtifact.contributorship.entry.contributionInstance [ # 0..* Contributions with accounting for time or number fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.type [ CodeableConcept ]; # 1..1 The specific contribution fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.time [ dateTime ]; # 0..1 The time that the contribution was made ], ...; fhir:Citation.citedArtifact.contributorship.entry.correspondingContact [ boolean ]; # 0..1 Indication of which contributor is the corresponding contributor for the rolefhir:fhir:Citation.citedArtifact.contributorship.entry.rankingOrder [ positiveInt ]; # 0..1 Ranked order of contribution ], ...; fhir:Citation.citedArtifact.contributorship.summary [ # 0..* Used to record a display of the author/contributor list without separate coding for each list member fhir:Citation.citedArtifact.contributorship.summary.type [ CodeableConcept ]; # 0..1 Either authorList or contributorshipStatement fhir:Citation.citedArtifact.contributorship.summary.style [ CodeableConcept ]; # 0..1 The format for the display string fhir:Citation.citedArtifact.contributorship.summary.source [ CodeableConcept ]; # 0..1 Used to code the producer or rule for creating the display string fhir:Citation.citedArtifact.contributorship.summary.value [ markdown ]; # 1..1 The display string for the author list, contributor list, or contributorship statement ], ...; ]; fhir:Citation.citedArtifact.note [ Annotation ], ... ; # 0..* Any additional information or content for the article or artifact ]; ]
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
,
the
extensions
spreadsheet
version
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Citation.status |
The lifecycle status of an artifact. |
Required | PublicationStatus |
| Citation.jurisdiction |
This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.
Note:
The
codes
for
countries
and
country
subdivisions
are
taken
from
ISO
3166
|
Extensible | Jurisdiction ValueSet |
| Citation.summary.style |
The format for display of the citation. |
Extensible | CitationSummaryStyle |
| Citation.classification.type |
Citation classification type |
Extensible | CitationClassificationType |
| Citation.classification.classifier |
Citation artifact classifier |
Example | CitationArtifactClassifier |
| Citation.currentState |
Citation status type |
Example | CitationStatusType |
| Citation.statusDate.activity |
Citation status type |
Example | CitationStatusType |
| Citation.citedArtifact.currentState |
Cited Artifact Status Type |
Extensible | CitedArtifactStatusType |
| Citation.citedArtifact.statusDate.activity |
Cited Artifact Status Type |
Extensible | CitedArtifactStatusType |
| Citation.citedArtifact.title.type |
Used to express the reason and specific aspect for the variant title, such as language and specific language. |
Extensible | TitleType |
| Citation.citedArtifact.title.language |
This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) |
Preferred | CommonLanguages |
| Citation.citedArtifact.abstract.type |
Used to express the reason and specific aspect for the variant abstract, such as language and specific language. |
Extensible | CitedArtifactAbstractType |
| Citation.citedArtifact.abstract.language |
This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) |
Preferred | CommonLanguages |
| Citation.citedArtifact.part.type |
To describe the reason for the variant citation, such as version number or subpart specification. |
Extensible | CitedArtifactPartType |
| Citation.citedArtifact.relatesTo.type |
The type of relationship to the cited artifact. |
|
|
|
|
Citation artifact classifier |
|
CitationArtifactClassifier |
| Citation.citedArtifact.publicationForm.publishedIn.type |
The type of publication such as book, database, or journal. |
Extensible | PublishedInType |
|
|
NLM codes Internet or Print. |
Extensible | CitedMedium |
| Citation.citedArtifact.publicationForm.language |
This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) |
Preferred | CommonLanguages |
| Citation.citedArtifact.webLocation.classifier |
Code the reason for different URLs, eg abstract and full-text. |
Extensible |
|
| Citation.citedArtifact.classification.type |
Cited Artifact Classification Type |
Extensible | CitedArtifactClassificationType |
| Citation.citedArtifact.classification.classifier |
Citation artifact classifier |
Example | CitationArtifactClassifier |
| Citation.citedArtifact.contributorship.entry.contributionType |
Citation contribution. |
Extensible | ArtifactContributionType |
| Citation.citedArtifact.contributorship.entry.role |
Used to code the format of the display string. |
Extensible | ContributorRole |
| Citation.citedArtifact.contributorship.entry.contributionInstance.type |
Artifact Contribution Instance Type |
Extensible | ArtifactContributionInstanceType |
| Citation.citedArtifact.contributorship.summary.type |
Used to code author list statement, contributorship statement, and such. |
Extensible | ContributorSummaryType |
| Citation.citedArtifact.contributorship.summary.style |
Used to code the format of the display string. |
Extensible | ContributorSummaryStyle |
| Citation.citedArtifact.contributorship.summary.source |
Used to code the producer or rule for creating the display string. |
Extensible | ContributorSummarySource |
|
|
Level | Location | Description | Expression |
cnl-0
|
Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists()
implies
|
|
cnl-1
| Warning | Citation.url | URL should not contain | or # - these characters make processing canonical references problematic | url.matches('([^|#])*') |
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 |
| context | token | A use context assigned to the citation | (Citation.useContext.value as CodeableConcept) | |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the citation | (Citation.useContext.value as Quantity) | (Citation.useContext.value as Range) | |
| context-type | token | A type of use context assigned to the citation | Citation.useContext.code | |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the citation |
On
Citation.useContext:
context-type: code context-quantity: |
|
| context-type-value | composite | A use context type and value assigned to the citation |
On
Citation.useContext:
context-type: code context: |
|
| date N | date | The citation publication date | Citation.date | |
| description N | string | The description of the citation | Citation.description | |
| effective | date | The time during which the citation is intended to be in use | Citation.effectivePeriod | |
| identifier | token | External identifier for the citation | Citation.identifier | |
| jurisdiction | token | Intended jurisdiction for the citation | Citation.jurisdiction | |
| name N | string | Computationally friendly name of the citation | Citation.name | |
| publisher N | string | Name of the publisher of the citation | Citation.publisher | |
| status N | token | The current status of the citation | Citation.status | |
| title N | string | The human-friendly name of the citation | Citation.title | |
| url N | uri | The uri that identifies the citation | Citation.url | |
| version N | token | The business version of the citation | Citation.version |
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:54+1000.
05:01+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change