FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

14.12 Resource Citation - Content

Clinical Decision Support icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: No 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.



14.12.1 Scope and Usage

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.

Although citations as a concept are certainly not unique to healthcare, their use within healthcare contexts is ubiquitous, especially as part of the need to cite literature references and scientific knowledge as part of supporting evidence. This need is already manifest in references to the Citation resource from other FHIR resources including ResearchStudy, SubstanceDefinition, and DiagnosticReport. In addition, citations of evidence are a critical aspect of evidence-based medicine and structures to represent citation information are a necessary modeling component in the EBM-on-FHIR project. Without a resource dedicated to this concept, evidence-based medicine concepts and approaches would need to rely on extensions and/or non-FHIR-based solutions to exchange citation information, resulting in more complex and difficult to implement and maintain resource types to support evidence-based medicine.

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.

14.12.2 Boundaries and Relationships

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.

Approaches to a citation standard external to FHIR are not well suited for integration with FHIR-based approaches to Evidence and related resources. The MEDLINE citation format is widely used but not extensible for many types of knowledge artifacts that may be cited and not open to community development through open standards development methods. The RIS citation format is widely used but is not a singularly maintained standard and multiple implementations using RIS in different ways leads to confusion and inefficiency.

14.12.3 References to this Resource

14.12.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 record, 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 record itself

... version Σ 0..1 string Business version of the citation record
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this citation record (computer friendly)
... title ΣT 0..1 string Name for this citation record (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher ΣT 0..1 string The publisher of the citation record, not the publisher of the article or artifact being cited
... contact Σ 0..* ContactDetail Contact details for the publisher of the citation record

... description T 0..1 markdown Natural language description of the citation
... useContext Σ 0..* UsageContext The context that the citation record content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for citation record (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this citation is defined
... copyright T 0..1 markdown Use and/or publishing restrictions for the citation record, not for the cited artifact
... copyrightLabel T 0..1 string Copyright holder and year(s) for the ciation record, not for the cited artifact
... approvalDate 0..1 date When the citation record was approved by publisher
... lastReviewDate 0..1 date When the citation record was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the citation record is expected to be used
... author 0..* ContactDetail Who authored the citation record

... editor 0..* ContactDetail Who edited the citation record

... reviewer 0..* ContactDetail Who reviewed the citation record

... endorser 0..* ContactDetail Who endorsed the citation record

... summary 0..* BackboneElement A human-readable display of key concepts to represent the citation

.... style 0..1 CodeableConcept Format for display of the citation summary
Binding: Citation Summary Style (Extensible)
.... text Σ 1..1 markdown The human-readable display of the citation summary
... classification 0..* BackboneElement The assignment to an organizing scheme

.... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: Citation Classification Type (Extensible)
.... classifier 0..* CodeableConcept The specific classification value
Binding: Citation Artifact Classifier (Example)

... note 0..* Annotation Used for general notes and annotations not coded elsewhere

... currentState 0..* CodeableConcept The status of the citation record
Binding: Citation Status Type (Example)

... statusDate 0..* BackboneElement An effective date or period for a status of the citation record

.... activity 1..1 CodeableConcept Classification of the status
Binding: Citation Status Type (Example)
.... actual 0..1 boolean Either occurred or expected
.... period 1..1 Period When the status started and/or ended
... relatedArtifact 0..* RelatedArtifact Artifact related to the citation record

... citedArtifact 0..1 BackboneElement The article or artifact being described
.... identifier Σ 0..* Identifier Unique identifier. May include DOI, PMID, PMCID, etc

.... relatedIdentifier Σ 0..* Identifier Identifier not unique to the cited artifact. 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
Binding: Cited Artifact Status Type (Extensible)

.... statusDate 0..* BackboneElement An effective date or period for a status of the cited artifact

..... activity 1..1 CodeableConcept Classification of the status
Binding: Cited Artifact Status Type (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
Binding: Title Type (Extensible)

..... language 0..1 CodeableConcept Used to express the specific language
Binding: 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
Binding: Cited Artifact Abstract Type (Extensible)
..... language 0..1 CodeableConcept Used to express the specific language
Binding: 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
Binding: Cited Artifact Part Type (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
Binding: Related Artifact Type All (Required)
..... classifier 0..* CodeableConcept Additional classifiers
Binding: Citation Artifact Classifier (Extensible)

..... label 0..1 string Short label
..... display 0..1 string Brief description of the related artifact
..... citation 0..1 markdown Bibliographic citation for the artifact
..... document 0..1 Attachment What document is being referenced
..... resource 0..1 canonical() What artifact is being referenced
..... resourceReference 0..1 Reference() 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)
Binding: Published In Type (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 or resource describing the publisher
...... publisherLocation 0..1 string Geographic location of the publisher
..... citedMedium 0..1 CodeableConcept Internet or Print
Binding: Cited Medium (Extensible)
..... volume 0..1 string Volume number of journal or other collection in which the article is published
..... issue 0..1 string Issue, part or supplement of journal or other collection in which the article is published
..... articleDate 0..1 dateTime The date the article was added to the database, or the date the article was released
..... publicationDateText 0..1 string Text representation of the date on which the issue of the cited artifact was published
..... publicationDateSeason 0..1 string Season in which the cited artifact was published
..... lastRevisionDate 0..1 dateTime The date the article was last revised or updated in the database
..... language 0..* CodeableConcept Language(s) in which this form of the article is published
Binding: 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
Binding: Artifact Url Classifier (Extensible)

..... 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)
Binding: Cited Artifact Classification Type (Extensible)
..... classifier 0..* CodeableConcept The specific classification value
Binding: Citation Artifact Classifier (Example)

..... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification

.... 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 as a contributor

...... contributor 1..1 Reference(Practitioner | Organization) The identity of the individual contributor
...... forenameInitials 0..1 string For citation styles that use initials
...... affiliation 0..* Reference(Organization | PractitionerRole) Organizational affiliation

...... contributionType 0..* CodeableConcept The specific contribution
Binding: Artifact Contribution Type (Extensible)

...... role 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer, funder)
Binding: Contributor Role (Extensible)
...... contributionInstance 0..* BackboneElement Contributions with accounting for time or number

....... type 1..1 CodeableConcept The specific contribution
Binding: Artifact Contribution Instance Type (Extensible)
....... time 0..1 dateTime The time that the contribution was made
...... correspondingContact 0..1 boolean Whether the contributor is the corresponding contributor for the role
...... rankingOrder 0..1 positiveInt Ranked order of contribution
..... summary 0..* BackboneElement Used to record a display of the author/contributor list without separate data element for each list member

...... type 0..1 CodeableConcept Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Binding: Contributor Summary Type (Extensible)
...... style 0..1 CodeableConcept The format for the display string
Binding: Contributor Summary Style (Extensible)
...... source 0..1 CodeableConcept Used to code the producer or rule for creating the display string
Binding: Contributor Summary Source (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


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

Citation (DomainResource) MetadataResourceAn absolute URI that is used to identify this citation record when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this citation record when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the citation record when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation record author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm »A natural language name identifying the citation record. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the citation recordtitle : string [0..1]The status of this summary. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this citation record is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the citation record was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation record changesdate : dateTime [0..1]The name of the organization or individual that published the citation recordpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the citation from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation record instancesuseContext : UsageContext [0..*]A legal or geographic region in which the citation record is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet »Explanation of why this citation is needed and why it has been designed as it haspurpose : markdown [0..1]Use and/or publishing restrictions for the citation record, not for the cited artifactcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the citation record content was or is planned to be in active useeffectivePeriod : Period [0..1]Who authored or created the citation recordauthor : ContactDetail [0..*]Who edited or revised the citation recordeditor : ContactDetail [0..*]Who reviewed the citation recordreviewer : ContactDetail [0..*]Who endorsed the citation recordendorser : ContactDetail [0..*]Used for general notes and annotations not coded elsewherenote : Annotation [0..*]The status of the citation recordcurrentState : CodeableConcept [0..*] « null (Strength=Example)CitationStatusType?? »Artifact related to the citation recordrelatedArtifact : RelatedArtifact [0..*]SummaryFormat for display of the citation summarystyle : CodeableConcept [0..1] « null (Strength=Extensible)CitationSummaryStyle »The human-readable display of the citation summarytext : markdown [1..1]ClassificationThe kind of classifier (e.g. publication type, keyword)type : CodeableConcept [0..1] « null (Strength=Extensible)CitationClassificationType »The specific classification valueclassifier : CodeableConcept [0..*] « null (Strength=Example)CitationArtifactClassifier?? »StatusDateThe state or status of the citation record (that will be paired with the period)activity : CodeableConcept [1..1] « null (Strength=Example)CitationStatusType?? »Whether the status date is actual (has occurred) or expected (estimated or anticipated)actual : boolean [0..1]When the status started and/or endedperiod : Period [1..1]CitedArtifactA formal identifier that is used to identify the cited artifact when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]A formal identifier that is used to identify things closely related to the cited artifactrelatedIdentifier : Identifier [0..*]When the cited artifact was accesseddateAccessed : dateTime [0..1]The status of the cited artifactcurrentState : CodeableConcept [0..*] « null (Strength=Extensible)CitedArtifactStatusType »Any additional information or content for the article or artifactnote : Annotation [0..*]VersionThe version number or other version identifiervalue : string [1..1]Citation for the main version of the cited artifactbaseCitation : Reference [0..1] « Citation »StatusDateA definition of the status associated with a date or periodactivity : CodeableConcept [1..1] « null (Strength=Extensible)CitedArtifactStatusType »Either occurred or expectedactual : boolean [0..1]When the status started and/or endedperiod : Period [1..1]TitleUsed to express the reason for or classification of the titletype : CodeableConcept [0..*] « null (Strength=Extensible)TitleType »Used to express the specific language of the titlelanguage : CodeableConcept [0..1] « A human language. (Strength=Preferred)CommonLanguages? »The title of the article or artifacttext : markdown [1..1]AbstractUsed to express the reason for or classification of the abstracttype : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactAbstractType »Used to express the specific language of the abstractlanguage : CodeableConcept [0..1] « A human language. (Strength=Preferred)CommonLanguages? »Abstract contenttext : markdown [1..1]Copyright notice for the abstractcopyright : markdown [0..1]PartThe kind of componenttype : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactPartType »The specification of the componentvalue : string [0..1]The citation for the full article or artifactbaseCitation : Reference [0..1] « Citation »RelatesToThe type of relationship to the related artifacttype : code [1..1] « null (Strength=Required)RelatedArtifactTypeExpanded! »Provides additional classifiers of the related artifactclassifier : CodeableConcept [0..*] « null (Strength=Extensible)CitationArtifactClassifier »A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote indexlabel : string [0..1]A brief description of the document or knowledge resource being referenced, suitable for display to a consumerdisplay : string [0..1]A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation formatcitation : markdown [0..1]The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifactdocument : Attachment [0..1]The related artifact, such as a library, value set, profile, or other knowledge resourceresource : canonical [0..1] « »The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resourceresourceReference : Reference [0..1] « »PublicationFormDescribes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issuecitedMedium : CodeableConcept [0..1] « null (Strength=Extensible)CitedMedium »Volume number of journal or other collection in which the article is publishedvolume : string [0..1]Issue, part or supplement of journal or other collection in which the article is publishedissue : string [0..1]The date the article was added to the database, or the date the article was releasedarticleDate : dateTime [0..1]Text representation of the date on which the issue of the cited artifact was publishedpublicationDateText : string [0..1]Spring, Summer, Fall/Autumn, WinterpublicationDateSeason : string [0..1]The date the article was last revised or updated in the databaselastRevisionDate : dateTime [0..1]The language or languages in which this form of the article is publishedlanguage : CodeableConcept [0..*] « A human language. (Strength=Preferred)CommonLanguages? »Entry number or identifier for inclusion in a databaseaccessionNumber : string [0..1]Used for full display of paginationpageString : string [0..1]Used for isolated representation of first pagefirstPage : string [0..1]Used for isolated representation of last pagelastPage : string [0..1]Actual or approximate number of pages or screens. Distinct from reporting the page numberspageCount : string [0..1]Copyright notice for the full article or artifactcopyright : markdown [0..1]PublishedInKind of container (e.g. Periodical, database, or book)type : CodeableConcept [0..1] « null (Strength=Extensible)PublishedInType »Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBNidentifier : Identifier [0..*]Name of the database or title of the book or journaltitle : string [0..1]Name of or resource describing the publisherpublisher : Reference [0..1] « Organization »Geographic location of the publisherpublisherLocation : string [0..1]WebLocationA characterization of the object expected at the web locationclassifier : CodeableConcept [0..*] « null (Strength=Extensible)ArtifactUrlClassifier »The specific URLurl : uri [0..1]ClassificationThe kind of classifier (e.g. publication type, keyword)type : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactClassificationTy... »The specific classification valueclassifier : CodeableConcept [0..*] « null (Strength=Example)CitationArtifactClassifier?? »Complex or externally created classificationartifactAssessment : Reference [0..*] « ArtifactAssessment »ContributorshipIndicates if the list includes all authors and/or contributorscomplete : boolean [0..1]EntryThe identity of the individual contributorcontributor : Reference [1..1] « Practitioner|Organization »For citation styles that use initialsforenameInitials : string [0..1]Organization affiliated with the contributoraffiliation : Reference [0..*] « Organization|PractitionerRole »This element identifies the specific nature of an individual’s contribution with respect to the cited workcontributionType : CodeableConcept [0..*] « null (Strength=Extensible)ArtifactContributionType »The role of the contributor (e.g. author, editor, reviewer, funder)role : CodeableConcept [0..1] « null (Strength=Extensible)ContributorRole »Whether the contributor is the corresponding contributor for the rolecorrespondingContact : boolean [0..1]Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second authorrankingOrder : positiveInt [0..1]ContributionInstanceThe specific contributiontype : CodeableConcept [1..1] « null (Strength=Extensible)ArtifactContributionInstanceT... »The time that the contribution was madetime : dateTime [0..1]ContributorshipSummaryUsed most commonly to express an author list or a contributorship statementtype : CodeableConcept [0..1] « null (Strength=Extensible)ContributorSummaryType »The format for the display string, such as author last name with first letter capitalized followed by forename initialsstyle : CodeableConcept [0..1] « null (Strength=Extensible)ContributorSummaryStyle »Used to code the producer or rule for creating the display stringsource : CodeableConcept [0..1] « null (Strength=Extensible)ContributorSummarySource »The display string for the author list, contributor list, or contributorship statementvalue : markdown [1..1]A human-readable display of key concepts to represent the citationsummary[0..*]The assignment to an organizing schemeclassification[0..*]The state or status of the citation record paired with an effective date or period for that statestatusDate[0..*]The defined version of the cited artifactversion[0..1]An effective date or period, historical or future, actual or expected, for a status of the cited artifactstatusDate[0..*]The title details of the article or artifacttitle[0..*]The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summariesabstract[0..*]The component of the article or artifactpart[0..1]The artifact related to the cited artifactrelatesTo[0..*]The collection the cited article or artifact is published inpublishedIn[0..1]If multiple, used to represent alternative forms of the article that are not separate citationspublicationForm[0..*]Used for any URL for the article or artifact citedwebLocation[0..*]The assignment to an organizing schemeclassification[0..*]Contributions with accounting for time or numbercontributionInstance[0..*]An individual entity named as a contributor, for example in the author list or contributor listentry[0..*]Used to record a display of the author/contributor list without separate data element for each list membersummary[0..*]This element is used to list authors and other contributors, their contact information, specific contributions, and summary statementscontributorship[0..1]The article or artifact being describedcitedArtifact[0..1]

XML Template

<Citation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this citation record, represented as a globally unique URI -->
 <identifier><!-- 0..* Identifier Identifier for the citation record itself --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the citation record -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this citation record (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this citation record (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 record, not the publisher of the article or artifact being cited -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher of the citation record --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the citation -->
 <useContext><!-- 0..* UsageContext The context that the citation record content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for citation record (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 record, not for the cited artifact -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) for the ciation record, not for the cited artifact -->
 <approvalDate value="[date]"/><!-- 0..1 When the citation record was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the citation record was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the citation record is expected to be used --></effectivePeriod>
 <author><!-- 0..* ContactDetail Who authored the citation record --></author>
 <editor><!-- 0..* ContactDetail Who edited the citation record --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the citation record --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the citation record --></endorser>
 <summary>  <!-- 0..* A human-readable display of key concepts to represent the citation -->
  <style><!-- 0..1 CodeableConcept Format for display of the citation summary --></style>
  <text value="[markdown]"/><!-- 1..1 The human-readable display of the citation summary -->
 </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 record --></currentState>
 <statusDate>  <!-- 0..* An effective date or period for a status of the citation record -->
  <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>
 <relatedArtifact><!-- 0..* RelatedArtifact Artifact related to the citation record --></relatedArtifact>
 <citedArtifact>  <!-- 0..1 The article or artifact being described -->
  <identifier><!-- 0..* Identifier Unique identifier. May include DOI, PMID, PMCID, etc --></identifier>
  <relatedIdentifier><!-- 0..* Identifier Identifier not unique to the cited artifact. 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 -->
   <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 or resource describing the publisher --></publisher>
    <publisherLocation value="[string]"/><!-- 0..1 Geographic location of the publisher -->
   </publishedIn>
   <citedMedium><!-- 0..1 CodeableConcept Internet or Print --></citedMedium>
   <volume value="[string]"/><!-- 0..1 Volume number of journal or other collection in which the article is published -->
   <issue value="[string]"/><!-- 0..1 Issue, part or supplement of journal or other collection in which the article is published -->
   <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released -->
   <publicationDateText value="[string]"/><!-- 0..1 Text representation of the date on which the issue of the cited artifact was published -->
   <publicationDateSeason value="[string]"/><!-- 0..1 Season in which the cited artifact was published -->
   <lastRevisionDate value="[dateTime]"/><!-- 0..1 The date the article was last revised or updated in the database -->
   <language><!-- 0..* CodeableConcept Language(s) 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 -->
   <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>
   <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 as a contributor -->
    <contributor><!-- 1..1 Reference(Organization|Practitioner) The identity of the individual contributor --></contributor>
    <forenameInitials value="[string]"/><!-- 0..1 For citation styles that use initials -->
    <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, funder) --></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 Whether the 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 data element for each list member -->
    <type><!-- 0..1 CodeableConcept Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement --></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

{doco
  "resourceType" : "Citation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this citation record, represented as a globally unique URI
  "identifier" : [{ Identifier }], // Identifier for the citation record itself
  "version" : "<string>", // Business version of the citation record
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this citation record (computer friendly)
  "title" : "<string>", // Name for this citation record (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 record, not the publisher of the article or artifact being cited
  "contact" : [{ ContactDetail }], // Contact details for the publisher of the citation record
  "description" : "<markdown>", // Natural language description of the citation
  "useContext" : [{ UsageContext }], // The context that the citation record content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation record (if applicable)
  "purpose" : "<markdown>", // Why this citation is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions for the citation record, not for the cited artifact
  "copyrightLabel" : "<string>", // Copyright holder and year(s) for the ciation record, not for the cited artifact
  "approvalDate" : "<date>", // When the citation record was approved by publisher
  "lastReviewDate" : "<date>", // When the citation record was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the citation record is expected to be used
  "author" : [{ ContactDetail }], // Who authored the citation record
  "editor" : [{ ContactDetail }], // Who edited the citation record
  "reviewer" : [{ ContactDetail }], // Who reviewed the citation record
  "endorser" : [{ ContactDetail }], // Who endorsed the citation record
  "summary" : [{ // A human-readable display of key concepts to represent the citation
    "style" : { CodeableConcept }, // Format for display of the citation summary
    "text" : "<markdown>" // R!  The human-readable display of the citation summary
  }],
  "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 record
  "statusDate" : [{ // An effective date or period for a status of the citation record
    "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 record
  "citedArtifact" : { // The article or artifact being described
    "identifier" : [{ Identifier }], // Unique identifier. May include DOI, PMID, PMCID, etc
    "relatedIdentifier" : [{ Identifier }], // Identifier not unique to the cited artifact. 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 or resource describing the publisher
        "publisherLocation" : "<string>" // Geographic location of the publisher
      },
      "citedMedium" : { CodeableConcept }, // Internet or Print
      "volume" : "<string>", // Volume number of journal or other collection in which the article is published
      "issue" : "<string>", // Issue, part or supplement of journal or other collection in which the article is published
      "articleDate" : "<dateTime>", // The date the article was added to the database, or the date the article was released
      "publicationDateText" : "<string>", // Text representation of the date on which the issue of the cited artifact was published
      "publicationDateSeason" : "<string>", // Season in which the cited artifact was published
      "lastRevisionDate" : "<dateTime>", // The date the article was last revised or updated in the database
      "language" : [{ CodeableConcept }], // Language(s) 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 as a contributor
        "contributor" : { Reference(Organization|Practitioner) }, // R!  The identity of the individual contributor
        "forenameInitials" : "<string>", // For citation styles that use initials
        "affiliation" : [{ Reference(Organization|PractitionerRole) }], // Organizational affiliation
        "contributionType" : [{ CodeableConcept }], // The specific contribution
        "role" : { CodeableConcept }, // The role of the contributor (e.g. author, editor, reviewer, funder)
        "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>, // Whether the 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 data element for each list member
        "type" : { CodeableConcept }, // Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
        "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/> .doco


[ a fhir:Citation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this citation record, represented as a globally unique URI
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifier for the citation record itself
  fhir:version [ string ] ; # 0..1 Business version of the citation record
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this citation record (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this citation record (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 The publisher of the citation record, not the publisher of the article or artifact being cited
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher of the citation record
  fhir:description [ markdown ] ; # 0..1 Natural language description of the citation
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the citation record content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for citation record (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this citation is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions for the citation record, not for the cited artifact
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) for the ciation record, not for the cited artifact
  fhir:approvalDate [ date ] ; # 0..1 When the citation record was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the citation record was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the citation record is expected to be used
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the citation record
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the citation record
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the citation record
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the citation record
  fhir:summary ( [ # 0..* A human-readable display of key concepts to represent the citation
    fhir:style [ CodeableConcept ] ; # 0..1 Format for display of the citation summary
    fhir:text [ markdown ] ; # 1..1 The human-readable display of the citation summary
  ] ... ) ;
  fhir:classification ( [ # 0..* The assignment to an organizing scheme
    fhir:type [ CodeableConcept ] ; # 0..1 The kind of classifier (e.g. publication type, keyword)
    fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* The specific classification value
  ] ... ) ;
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for general notes and annotations not coded elsewhere
  fhir:currentState  ( [ CodeableConcept ] ... ) ; # 0..* The status of the citation record
  fhir:statusDate ( [ # 0..* An effective date or period for a status of the citation record
    fhir:activity [ CodeableConcept ] ; # 1..1 Classification of the status
    fhir:actual [ boolean ] ; # 0..1 Either occurred or expected
    fhir:period [ Period ] ; # 1..1 When the status started and/or ended
  ] ... ) ;
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Artifact related to the citation record
  fhir:citedArtifact [ # 0..1 The article or artifact being described
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Unique identifier. May include DOI, PMID, PMCID, etc
    fhir:relatedIdentifier  ( [ Identifier ] ... ) ; # 0..* Identifier not unique to the cited artifact. May include trial registry identifiers
    fhir:dateAccessed [ dateTime ] ; # 0..1 When the cited artifact was accessed
    fhir:version [ # 0..1 The defined version of the cited artifact
      fhir:value [ string ] ; # 1..1 The version number or other version identifier
      fhir:baseCitation [ Reference(Citation) ] ; # 0..1 Citation for the main version of the cited artifact
    ] ;
    fhir:currentState  ( [ CodeableConcept ] ... ) ; # 0..* The status of the cited artifact
    fhir:statusDate ( [ # 0..* An effective date or period for a status of the cited artifact
      fhir:activity [ CodeableConcept ] ; # 1..1 Classification of the status
      fhir:actual [ boolean ] ; # 0..1 Either occurred or expected
      fhir:period [ Period ] ; # 1..1 When the status started and/or ended
    ] ... ) ;
    fhir:title ( [ # 0..* The title details of the article or artifact
      fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The kind of title
      fhir:language [ CodeableConcept ] ; # 0..1 Used to express the specific language
      fhir:text [ markdown ] ; # 1..1 The title of the article or artifact
    ] ... ) ;
    fhir:abstract ( [ # 0..* Summary of the article or artifact
      fhir:type [ CodeableConcept ] ; # 0..1 The kind of abstract
      fhir:language [ CodeableConcept ] ; # 0..1 Used to express the specific language
      fhir:text [ markdown ] ; # 1..1 Abstract content
      fhir:copyright [ markdown ] ; # 0..1 Copyright notice for the abstract
    ] ... ) ;
    fhir:part [ # 0..1 The component of the article or artifact
      fhir:type [ CodeableConcept ] ; # 0..1 The kind of component
      fhir:value [ string ] ; # 0..1 The specification of the component
      fhir:baseCitation [ Reference(Citation) ] ; # 0..1 The citation for the full article or artifact
    ] ;
    fhir:relatesTo ( [ # 0..* The artifact related to the cited artifact
      fhir: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:classifier  ( [ CodeableConcept ] ... ) ; # 0..* Additional classifiers
      fhir:label [ string ] ; # 0..1 Short label
      fhir:display [ string ] ; # 0..1 Brief description of the related artifact
      fhir:citation [ markdown ] ; # 0..1 Bibliographic citation for the artifact
      fhir:document [ Attachment ] ; # 0..1 What document is being referenced
      fhir:resource [ canonical ] ; # 0..1 What artifact is being referenced
      fhir:resourceReference [ Reference ] ; # 0..1 What artifact, if not a conformance resource
    ] ... ) ;
    fhir:publicationForm ( [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations
      fhir:publishedIn [ # 0..1 The collection the cited article or artifact is published in
        fhir:type [ CodeableConcept ] ; # 0..1 Kind of container (e.g. Periodical, database, or book)
        fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
        fhir:title [ string ] ; # 0..1 Name of the database or title of the book or journal
        fhir:publisher [ Reference(Organization) ] ; # 0..1 Name of or resource describing the publisher
        fhir:publisherLocation [ string ] ; # 0..1 Geographic location of the publisher
      ] ;
      fhir:citedMedium [ CodeableConcept ] ; # 0..1 Internet or Print
      fhir:volume [ string ] ; # 0..1 Volume number of journal or other collection in which the article is published
      fhir:issue [ string ] ; # 0..1 Issue, part or supplement of journal or other collection in which the article is published
      fhir:articleDate [ dateTime ] ; # 0..1 The date the article was added to the database, or the date the article was released
      fhir:publicationDateText [ string ] ; # 0..1 Text representation of the date on which the issue of the cited artifact was published
      fhir:publicationDateSeason [ string ] ; # 0..1 Season in which the cited artifact was published
      fhir:lastRevisionDate [ dateTime ] ; # 0..1 The date the article was last revised or updated in the database
      fhir:language  ( [ CodeableConcept ] ... ) ; # 0..* Language(s) in which this form of the article is published
      fhir:accessionNumber [ string ] ; # 0..1 Entry number or identifier for inclusion in a database
      fhir:pageString [ string ] ; # 0..1 Used for full display of pagination
      fhir:firstPage [ string ] ; # 0..1 Used for isolated representation of first page
      fhir:lastPage [ string ] ; # 0..1 Used for isolated representation of last page
      fhir:pageCount [ string ] ; # 0..1 Number of pages or screens
      fhir:copyright [ markdown ] ; # 0..1 Copyright notice for the full article or artifact
    ] ... ) ;
    fhir:webLocation ( [ # 0..* Used for any URL for the article or artifact cited
      fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* Code the reason for different URLs, e.g. abstract and full-text
      fhir:url [ uri ] ; # 0..1 The specific URL
    ] ... ) ;
    fhir:classification ( [ # 0..* The assignment to an organizing scheme
      fhir:type [ CodeableConcept ] ; # 0..1 The kind of classifier (e.g. publication type, keyword)
      fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* The specific classification value
      fhir:artifactAssessment  ( [ Reference(ArtifactAssessment) ] ... ) ; # 0..* Complex or externally created classification
    ] ... ) ;
    fhir:contributorship [ # 0..1 Attribution of authors and other contributors
      fhir:complete [ boolean ] ; # 0..1 Indicates if the list includes all authors and/or contributors
      fhir:entry ( [ # 0..* An individual entity named as a contributor
        fhir:contributor [ Reference(Organization|Practitioner) ] ; # 1..1 The identity of the individual contributor
        fhir:forenameInitials [ string ] ; # 0..1 For citation styles that use initials
        fhir:affiliation  ( [ Reference(Organization|PractitionerRole) ] ... ) ; # 0..* Organizational affiliation
        fhir:contributionType  ( [ CodeableConcept ] ... ) ; # 0..* The specific contribution
        fhir:role [ CodeableConcept ] ; # 0..1 The role of the contributor (e.g. author, editor, reviewer, funder)
        fhir:contributionInstance ( [ # 0..* Contributions with accounting for time or number
          fhir:type [ CodeableConcept ] ; # 1..1 The specific contribution
          fhir:time [ dateTime ] ; # 0..1 The time that the contribution was made
        ] ... ) ;
        fhir:correspondingContact [ boolean ] ; # 0..1 Whether the contributor is the corresponding contributor for the role
        fhir:rankingOrder [ positiveInt ] ; # 0..1 Ranked order of contribution
      ] ... ) ;
      fhir:summary ( [ # 0..* Used to record a display of the author/contributor list without separate data element for each list member
        fhir:type [ CodeableConcept ] ; # 0..1 Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
        fhir:style [ CodeableConcept ] ; # 0..1 The format for the display string
        fhir:source [ CodeableConcept ] ; # 0..1 Used to code the producer or rule for creating the display string
        fhir:value [ markdown ] ; # 1..1 The display string for the author list, contributor list, or contributorship statement
      ] ... ) ;
    ] ;
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Any additional information or content for the article or artifact
  ] ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 record, 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 record itself

... version Σ 0..1 string Business version of the citation record
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this citation record (computer friendly)
... title ΣT 0..1 string Name for this citation record (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher ΣT 0..1 string The publisher of the citation record, not the publisher of the article or artifact being cited
... contact Σ 0..* ContactDetail Contact details for the publisher of the citation record

... description T 0..1 markdown Natural language description of the citation
... useContext Σ 0..* UsageContext The context that the citation record content is intended to support

... jurisdiction ΣXD 0..* CodeableConcept Intended jurisdiction for citation record (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T 0..1 markdown Why this citation is defined
... copyright T 0..1 markdown Use and/or publishing restrictions for the citation record, not for the cited artifact
... copyrightLabel T 0..1 string Copyright holder and year(s) for the ciation record, not for the cited artifact
... approvalDate 0..1 date When the citation record was approved by publisher
... lastReviewDate 0..1 date When the citation record was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period When the citation record is expected to be used
... author 0..* ContactDetail Who authored the citation record

... editor 0..* ContactDetail Who edited the citation record

... reviewer 0..* ContactDetail Who reviewed the citation record

... endorser 0..* ContactDetail Who endorsed the citation record

... summary 0..* BackboneElement A human-readable display of key concepts to represent the citation

.... style 0..1 CodeableConcept Format for display of the citation summary
Binding: Citation Summary Style (Extensible)
.... text Σ 1..1 markdown The human-readable display of the citation summary
... classification 0..* BackboneElement The assignment to an organizing scheme

.... type 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword)
Binding: Citation Classification Type (Extensible)
.... classifier 0..* CodeableConcept The specific classification value
Binding: Citation Artifact Classifier (Example)

... note 0..* Annotation Used for general notes and annotations not coded elsewhere

... currentState 0..* CodeableConcept The status of the citation record
Binding: Citation Status Type (Example)

... statusDate 0..* BackboneElement An effective date or period for a status of the citation record

.... activity 1..1 CodeableConcept Classification of the status
Binding: Citation Status Type (Example)
.... actual 0..1 boolean Either occurred or expected
.... period 1..1 Period When the status started and/or ended
... relatedArtifact 0..* RelatedArtifact Artifact related to the citation record

... citedArtifact 0..1 BackboneElement The article or artifact being described
.... identifier Σ 0..* Identifier Unique identifier. May include DOI, PMID, PMCID, etc

.... relatedIdentifier Σ 0..* Identifier Identifier not unique to the cited artifact. 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
Binding: Cited Artifact Status Type (Extensible)

.... statusDate 0..* BackboneElement An effective date or period for a status of the cited artifact

..... activity 1..1 CodeableConcept Classification of the status
Binding: Cited Artifact Status Type (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
Binding: Title Type (Extensible)

..... language 0..1 CodeableConcept Used to express the specific language
Binding: 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
Binding: Cited Artifact Abstract Type (Extensible)
..... language 0..1 CodeableConcept Used to express the specific language
Binding: 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
Binding: Cited Artifact Part Type (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
Binding: Related Artifact Type All (Required)
..... classifier 0..* CodeableConcept Additional classifiers
Binding: Citation Artifact Classifier (Extensible)

..... label 0..1 string Short label
..... display 0..1 string Brief description of the related artifact
..... citation 0..1 markdown Bibliographic citation for the artifact
..... document 0..1 Attachment What document is being referenced
..... resource 0..1 canonical() What artifact is being referenced
..... resourceReference 0..1 Reference() 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)
Binding: Published In Type (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 or resource describing the publisher
...... publisherLocation 0..1 string Geographic location of the publisher
..... citedMedium 0..1 CodeableConcept Internet or Print
Binding: Cited Medium (Extensible)
..... volume 0..1 string Volume number of journal or other collection in which the article is published
..... issue 0..1 string Issue, part or supplement of journal or other collection in which the article is published
..... articleDate 0..1 dateTime The date the article was added to the database, or the date the article was released
..... publicationDateText 0..1 string Text representation of the date on which the issue of the cited artifact was published
..... publicationDateSeason 0..1 string Season in which the cited artifact was published
..... lastRevisionDate 0..1 dateTime The date the article was last revised or updated in the database
..... language 0..* CodeableConcept Language(s) in which this form of the article is published
Binding: 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
Binding: Artifact Url Classifier (Extensible)

..... 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)
Binding: Cited Artifact Classification Type (Extensible)
..... classifier 0..* CodeableConcept The specific classification value
Binding: Citation Artifact Classifier (Example)

..... artifactAssessment 0..* Reference(ArtifactAssessment) Complex or externally created classification

.... 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 as a contributor

...... contributor 1..1 Reference(Practitioner | Organization) The identity of the individual contributor
...... forenameInitials 0..1 string For citation styles that use initials
...... affiliation 0..* Reference(Organization | PractitionerRole) Organizational affiliation

...... contributionType 0..* CodeableConcept The specific contribution
Binding: Artifact Contribution Type (Extensible)

...... role 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer, funder)
Binding: Contributor Role (Extensible)
...... contributionInstance 0..* BackboneElement Contributions with accounting for time or number

....... type 1..1 CodeableConcept The specific contribution
Binding: Artifact Contribution Instance Type (Extensible)
....... time 0..1 dateTime The time that the contribution was made
...... correspondingContact 0..1 boolean Whether the contributor is the corresponding contributor for the role
...... rankingOrder 0..1 positiveInt Ranked order of contribution
..... summary 0..* BackboneElement Used to record a display of the author/contributor list without separate data element for each list member

...... type 0..1 CodeableConcept Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
Binding: Contributor Summary Type (Extensible)
...... style 0..1 CodeableConcept The format for the display string
Binding: Contributor Summary Style (Extensible)
...... source 0..1 CodeableConcept Used to code the producer or rule for creating the display string
Binding: Contributor Summary Source (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


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

Citation (DomainResource) MetadataResourceAn absolute URI that is used to identify this citation record when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this citation record when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the citation record when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation record author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm »A natural language name identifying the citation record. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the citation recordtitle : string [0..1]The status of this summary. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this citation record is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the citation record was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation record changesdate : dateTime [0..1]The name of the organization or individual that published the citation recordpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the citation from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation record instancesuseContext : UsageContext [0..*]A legal or geographic region in which the citation record is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet »Explanation of why this citation is needed and why it has been designed as it haspurpose : markdown [0..1]Use and/or publishing restrictions for the citation record, not for the cited artifactcopyright : markdown [0..1]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the citation record content was or is planned to be in active useeffectivePeriod : Period [0..1]Who authored or created the citation recordauthor : ContactDetail [0..*]Who edited or revised the citation recordeditor : ContactDetail [0..*]Who reviewed the citation recordreviewer : ContactDetail [0..*]Who endorsed the citation recordendorser : ContactDetail [0..*]Used for general notes and annotations not coded elsewherenote : Annotation [0..*]The status of the citation recordcurrentState : CodeableConcept [0..*] « null (Strength=Example)CitationStatusType?? »Artifact related to the citation recordrelatedArtifact : RelatedArtifact [0..*]SummaryFormat for display of the citation summarystyle : CodeableConcept [0..1] « null (Strength=Extensible)CitationSummaryStyle »The human-readable display of the citation summarytext : markdown [1..1]ClassificationThe kind of classifier (e.g. publication type, keyword)type : CodeableConcept [0..1] « null (Strength=Extensible)CitationClassificationType »The specific classification valueclassifier : CodeableConcept [0..*] « null (Strength=Example)CitationArtifactClassifier?? »StatusDateThe state or status of the citation record (that will be paired with the period)activity : CodeableConcept [1..1] « null (Strength=Example)CitationStatusType?? »Whether the status date is actual (has occurred) or expected (estimated or anticipated)actual : boolean [0..1]When the status started and/or endedperiod : Period [1..1]CitedArtifactA formal identifier that is used to identify the cited artifact when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]A formal identifier that is used to identify things closely related to the cited artifactrelatedIdentifier : Identifier [0..*]When the cited artifact was accesseddateAccessed : dateTime [0..1]The status of the cited artifactcurrentState : CodeableConcept [0..*] « null (Strength=Extensible)CitedArtifactStatusType »Any additional information or content for the article or artifactnote : Annotation [0..*]VersionThe version number or other version identifiervalue : string [1..1]Citation for the main version of the cited artifactbaseCitation : Reference [0..1] « Citation »StatusDateA definition of the status associated with a date or periodactivity : CodeableConcept [1..1] « null (Strength=Extensible)CitedArtifactStatusType »Either occurred or expectedactual : boolean [0..1]When the status started and/or endedperiod : Period [1..1]TitleUsed to express the reason for or classification of the titletype : CodeableConcept [0..*] « null (Strength=Extensible)TitleType »Used to express the specific language of the titlelanguage : CodeableConcept [0..1] « A human language. (Strength=Preferred)CommonLanguages? »The title of the article or artifacttext : markdown [1..1]AbstractUsed to express the reason for or classification of the abstracttype : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactAbstractType »Used to express the specific language of the abstractlanguage : CodeableConcept [0..1] « A human language. (Strength=Preferred)CommonLanguages? »Abstract contenttext : markdown [1..1]Copyright notice for the abstractcopyright : markdown [0..1]PartThe kind of componenttype : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactPartType »The specification of the componentvalue : string [0..1]The citation for the full article or artifactbaseCitation : Reference [0..1] « Citation »RelatesToThe type of relationship to the related artifacttype : code [1..1] « null (Strength=Required)RelatedArtifactTypeExpanded! »Provides additional classifiers of the related artifactclassifier : CodeableConcept [0..*] « null (Strength=Extensible)CitationArtifactClassifier »A short label that can be used to reference the related artifact from elsewhere in the containing artifact, such as a footnote indexlabel : string [0..1]A brief description of the document or knowledge resource being referenced, suitable for display to a consumerdisplay : string [0..1]A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation formatcitation : markdown [0..1]The document being referenced, represented as an attachment. Do not use this element if using the resource element to provide the canonical to the related artifactdocument : Attachment [0..1]The related artifact, such as a library, value set, profile, or other knowledge resourceresource : canonical [0..1] « »The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resourceresourceReference : Reference [0..1] « »PublicationFormDescribes the form of the medium cited. Common codes are "Internet" or "Print". The CitedMedium value set has 6 codes. The codes internet, print, and offline-digital-storage are the common codes for a typical publication form, though internet and print are more common for study citations. Three additional codes (each appending one of the primary codes with "-without-issue" are used for situations when a study is published both within an issue (of a periodical release as commonly done for journals) AND is published separately from the issue (as commonly done with early online publication), to represent specific identification of the publication form not associated with the issuecitedMedium : CodeableConcept [0..1] « null (Strength=Extensible)CitedMedium »Volume number of journal or other collection in which the article is publishedvolume : string [0..1]Issue, part or supplement of journal or other collection in which the article is publishedissue : string [0..1]The date the article was added to the database, or the date the article was releasedarticleDate : dateTime [0..1]Text representation of the date on which the issue of the cited artifact was publishedpublicationDateText : string [0..1]Spring, Summer, Fall/Autumn, WinterpublicationDateSeason : string [0..1]The date the article was last revised or updated in the databaselastRevisionDate : dateTime [0..1]The language or languages in which this form of the article is publishedlanguage : CodeableConcept [0..*] « A human language. (Strength=Preferred)CommonLanguages? »Entry number or identifier for inclusion in a databaseaccessionNumber : string [0..1]Used for full display of paginationpageString : string [0..1]Used for isolated representation of first pagefirstPage : string [0..1]Used for isolated representation of last pagelastPage : string [0..1]Actual or approximate number of pages or screens. Distinct from reporting the page numberspageCount : string [0..1]Copyright notice for the full article or artifactcopyright : markdown [0..1]PublishedInKind of container (e.g. Periodical, database, or book)type : CodeableConcept [0..1] « null (Strength=Extensible)PublishedInType »Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBNidentifier : Identifier [0..*]Name of the database or title of the book or journaltitle : string [0..1]Name of or resource describing the publisherpublisher : Reference [0..1] « Organization »Geographic location of the publisherpublisherLocation : string [0..1]WebLocationA characterization of the object expected at the web locationclassifier : CodeableConcept [0..*] « null (Strength=Extensible)ArtifactUrlClassifier »The specific URLurl : uri [0..1]ClassificationThe kind of classifier (e.g. publication type, keyword)type : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactClassificationTy... »The specific classification valueclassifier : CodeableConcept [0..*] « null (Strength=Example)CitationArtifactClassifier?? »Complex or externally created classificationartifactAssessment : Reference [0..*] « ArtifactAssessment »ContributorshipIndicates if the list includes all authors and/or contributorscomplete : boolean [0..1]EntryThe identity of the individual contributorcontributor : Reference [1..1] « Practitioner|Organization »For citation styles that use initialsforenameInitials : string [0..1]Organization affiliated with the contributoraffiliation : Reference [0..*] « Organization|PractitionerRole »This element identifies the specific nature of an individual’s contribution with respect to the cited workcontributionType : CodeableConcept [0..*] « null (Strength=Extensible)ArtifactContributionType »The role of the contributor (e.g. author, editor, reviewer, funder)role : CodeableConcept [0..1] « null (Strength=Extensible)ContributorRole »Whether the contributor is the corresponding contributor for the rolecorrespondingContact : boolean [0..1]Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second authorrankingOrder : positiveInt [0..1]ContributionInstanceThe specific contributiontype : CodeableConcept [1..1] « null (Strength=Extensible)ArtifactContributionInstanceT... »The time that the contribution was madetime : dateTime [0..1]ContributorshipSummaryUsed most commonly to express an author list or a contributorship statementtype : CodeableConcept [0..1] « null (Strength=Extensible)ContributorSummaryType »The format for the display string, such as author last name with first letter capitalized followed by forename initialsstyle : CodeableConcept [0..1] « null (Strength=Extensible)ContributorSummaryStyle »Used to code the producer or rule for creating the display stringsource : CodeableConcept [0..1] « null (Strength=Extensible)ContributorSummarySource »The display string for the author list, contributor list, or contributorship statementvalue : markdown [1..1]A human-readable display of key concepts to represent the citationsummary[0..*]The assignment to an organizing schemeclassification[0..*]The state or status of the citation record paired with an effective date or period for that statestatusDate[0..*]The defined version of the cited artifactversion[0..1]An effective date or period, historical or future, actual or expected, for a status of the cited artifactstatusDate[0..*]The title details of the article or artifacttitle[0..*]The abstract may be used to convey article-contained abstracts, externally-created abstracts, or other descriptive summariesabstract[0..*]The component of the article or artifactpart[0..1]The artifact related to the cited artifactrelatesTo[0..*]The collection the cited article or artifact is published inpublishedIn[0..1]If multiple, used to represent alternative forms of the article that are not separate citationspublicationForm[0..*]Used for any URL for the article or artifact citedwebLocation[0..*]The assignment to an organizing schemeclassification[0..*]Contributions with accounting for time or numbercontributionInstance[0..*]An individual entity named as a contributor, for example in the author list or contributor listentry[0..*]Used to record a display of the author/contributor list without separate data element for each list membersummary[0..*]This element is used to list authors and other contributors, their contact information, specific contributions, and summary statementscontributorship[0..1]The article or artifact being describedcitedArtifact[0..1]

XML Template

<Citation xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this citation record, represented as a globally unique URI -->
 <identifier><!-- 0..* Identifier Identifier for the citation record itself --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the citation record -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this citation record (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this citation record (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 record, not the publisher of the article or artifact being cited -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher of the citation record --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the citation -->
 <useContext><!-- 0..* UsageContext The context that the citation record content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for citation record (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 record, not for the cited artifact -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) for the ciation record, not for the cited artifact -->
 <approvalDate value="[date]"/><!-- 0..1 When the citation record was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the citation record was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the citation record is expected to be used --></effectivePeriod>
 <author><!-- 0..* ContactDetail Who authored the citation record --></author>
 <editor><!-- 0..* ContactDetail Who edited the citation record --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the citation record --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the citation record --></endorser>
 <summary>  <!-- 0..* A human-readable display of key concepts to represent the citation -->
  <style><!-- 0..1 CodeableConcept Format for display of the citation summary --></style>
  <text value="[markdown]"/><!-- 1..1 The human-readable display of the citation summary -->
 </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 record --></currentState>
 <statusDate>  <!-- 0..* An effective date or period for a status of the citation record -->
  <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>
 <relatedArtifact><!-- 0..* RelatedArtifact Artifact related to the citation record --></relatedArtifact>
 <citedArtifact>  <!-- 0..1 The article or artifact being described -->
  <identifier><!-- 0..* Identifier Unique identifier. May include DOI, PMID, PMCID, etc --></identifier>
  <relatedIdentifier><!-- 0..* Identifier Identifier not unique to the cited artifact. 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 -->
   <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 or resource describing the publisher --></publisher>
    <publisherLocation value="[string]"/><!-- 0..1 Geographic location of the publisher -->
   </publishedIn>
   <citedMedium><!-- 0..1 CodeableConcept Internet or Print --></citedMedium>
   <volume value="[string]"/><!-- 0..1 Volume number of journal or other collection in which the article is published -->
   <issue value="[string]"/><!-- 0..1 Issue, part or supplement of journal or other collection in which the article is published -->
   <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released -->
   <publicationDateText value="[string]"/><!-- 0..1 Text representation of the date on which the issue of the cited artifact was published -->
   <publicationDateSeason value="[string]"/><!-- 0..1 Season in which the cited artifact was published -->
   <lastRevisionDate value="[dateTime]"/><!-- 0..1 The date the article was last revised or updated in the database -->
   <language><!-- 0..* CodeableConcept Language(s) 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 -->
   <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>
   <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 as a contributor -->
    <contributor><!-- 1..1 Reference(Organization|Practitioner) The identity of the individual contributor --></contributor>
    <forenameInitials value="[string]"/><!-- 0..1 For citation styles that use initials -->
    <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, funder) --></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 Whether the 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 data element for each list member -->
    <type><!-- 0..1 CodeableConcept Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement --></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

{doco
  "resourceType" : "Citation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this citation record, represented as a globally unique URI
  "identifier" : [{ Identifier }], // Identifier for the citation record itself
  "version" : "<string>", // Business version of the citation record
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this citation record (computer friendly)
  "title" : "<string>", // Name for this citation record (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 record, not the publisher of the article or artifact being cited
  "contact" : [{ ContactDetail }], // Contact details for the publisher of the citation record
  "description" : "<markdown>", // Natural language description of the citation
  "useContext" : [{ UsageContext }], // The context that the citation record content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation record (if applicable)
  "purpose" : "<markdown>", // Why this citation is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions for the citation record, not for the cited artifact
  "copyrightLabel" : "<string>", // Copyright holder and year(s) for the ciation record, not for the cited artifact
  "approvalDate" : "<date>", // When the citation record was approved by publisher
  "lastReviewDate" : "<date>", // When the citation record was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the citation record is expected to be used
  "author" : [{ ContactDetail }], // Who authored the citation record
  "editor" : [{ ContactDetail }], // Who edited the citation record
  "reviewer" : [{ ContactDetail }], // Who reviewed the citation record
  "endorser" : [{ ContactDetail }], // Who endorsed the citation record
  "summary" : [{ // A human-readable display of key concepts to represent the citation
    "style" : { CodeableConcept }, // Format for display of the citation summary
    "text" : "<markdown>" // R!  The human-readable display of the citation summary
  }],
  "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 record
  "statusDate" : [{ // An effective date or period for a status of the citation record
    "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 record
  "citedArtifact" : { // The article or artifact being described
    "identifier" : [{ Identifier }], // Unique identifier. May include DOI, PMID, PMCID, etc
    "relatedIdentifier" : [{ Identifier }], // Identifier not unique to the cited artifact. 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 or resource describing the publisher
        "publisherLocation" : "<string>" // Geographic location of the publisher
      },
      "citedMedium" : { CodeableConcept }, // Internet or Print
      "volume" : "<string>", // Volume number of journal or other collection in which the article is published
      "issue" : "<string>", // Issue, part or supplement of journal or other collection in which the article is published
      "articleDate" : "<dateTime>", // The date the article was added to the database, or the date the article was released
      "publicationDateText" : "<string>", // Text representation of the date on which the issue of the cited artifact was published
      "publicationDateSeason" : "<string>", // Season in which the cited artifact was published
      "lastRevisionDate" : "<dateTime>", // The date the article was last revised or updated in the database
      "language" : [{ CodeableConcept }], // Language(s) 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 as a contributor
        "contributor" : { Reference(Organization|Practitioner) }, // R!  The identity of the individual contributor
        "forenameInitials" : "<string>", // For citation styles that use initials
        "affiliation" : [{ Reference(Organization|PractitionerRole) }], // Organizational affiliation
        "contributionType" : [{ CodeableConcept }], // The specific contribution
        "role" : { CodeableConcept }, // The role of the contributor (e.g. author, editor, reviewer, funder)
        "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>, // Whether the 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 data element for each list member
        "type" : { CodeableConcept }, // Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
        "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/> .doco


[ a fhir:Citation;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this citation record, represented as a globally unique URI
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Identifier for the citation record itself
  fhir:version [ string ] ; # 0..1 Business version of the citation record
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this citation record (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this citation record (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 The publisher of the citation record, not the publisher of the article or artifact being cited
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher of the citation record
  fhir:description [ markdown ] ; # 0..1 Natural language description of the citation
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the citation record content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for citation record (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this citation is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions for the citation record, not for the cited artifact
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) for the ciation record, not for the cited artifact
  fhir:approvalDate [ date ] ; # 0..1 When the citation record was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the citation record was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the citation record is expected to be used
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the citation record
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the citation record
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the citation record
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the citation record
  fhir:summary ( [ # 0..* A human-readable display of key concepts to represent the citation
    fhir:style [ CodeableConcept ] ; # 0..1 Format for display of the citation summary
    fhir:text [ markdown ] ; # 1..1 The human-readable display of the citation summary
  ] ... ) ;
  fhir:classification ( [ # 0..* The assignment to an organizing scheme
    fhir:type [ CodeableConcept ] ; # 0..1 The kind of classifier (e.g. publication type, keyword)
    fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* The specific classification value
  ] ... ) ;
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for general notes and annotations not coded elsewhere
  fhir:currentState  ( [ CodeableConcept ] ... ) ; # 0..* The status of the citation record
  fhir:statusDate ( [ # 0..* An effective date or period for a status of the citation record
    fhir:activity [ CodeableConcept ] ; # 1..1 Classification of the status
    fhir:actual [ boolean ] ; # 0..1 Either occurred or expected
    fhir:period [ Period ] ; # 1..1 When the status started and/or ended
  ] ... ) ;
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Artifact related to the citation record
  fhir:citedArtifact [ # 0..1 The article or artifact being described
    fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Unique identifier. May include DOI, PMID, PMCID, etc
    fhir:relatedIdentifier  ( [ Identifier ] ... ) ; # 0..* Identifier not unique to the cited artifact. May include trial registry identifiers
    fhir:dateAccessed [ dateTime ] ; # 0..1 When the cited artifact was accessed
    fhir:version [ # 0..1 The defined version of the cited artifact
      fhir:value [ string ] ; # 1..1 The version number or other version identifier
      fhir:baseCitation [ Reference(Citation) ] ; # 0..1 Citation for the main version of the cited artifact
    ] ;
    fhir:currentState  ( [ CodeableConcept ] ... ) ; # 0..* The status of the cited artifact
    fhir:statusDate ( [ # 0..* An effective date or period for a status of the cited artifact
      fhir:activity [ CodeableConcept ] ; # 1..1 Classification of the status
      fhir:actual [ boolean ] ; # 0..1 Either occurred or expected
      fhir:period [ Period ] ; # 1..1 When the status started and/or ended
    ] ... ) ;
    fhir:title ( [ # 0..* The title details of the article or artifact
      fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The kind of title
      fhir:language [ CodeableConcept ] ; # 0..1 Used to express the specific language
      fhir:text [ markdown ] ; # 1..1 The title of the article or artifact
    ] ... ) ;
    fhir:abstract ( [ # 0..* Summary of the article or artifact
      fhir:type [ CodeableConcept ] ; # 0..1 The kind of abstract
      fhir:language [ CodeableConcept ] ; # 0..1 Used to express the specific language
      fhir:text [ markdown ] ; # 1..1 Abstract content
      fhir:copyright [ markdown ] ; # 0..1 Copyright notice for the abstract
    ] ... ) ;
    fhir:part [ # 0..1 The component of the article or artifact
      fhir:type [ CodeableConcept ] ; # 0..1 The kind of component
      fhir:value [ string ] ; # 0..1 The specification of the component
      fhir:baseCitation [ Reference(Citation) ] ; # 0..1 The citation for the full article or artifact
    ] ;
    fhir:relatesTo ( [ # 0..* The artifact related to the cited artifact
      fhir: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:classifier  ( [ CodeableConcept ] ... ) ; # 0..* Additional classifiers
      fhir:label [ string ] ; # 0..1 Short label
      fhir:display [ string ] ; # 0..1 Brief description of the related artifact
      fhir:citation [ markdown ] ; # 0..1 Bibliographic citation for the artifact
      fhir:document [ Attachment ] ; # 0..1 What document is being referenced
      fhir:resource [ canonical ] ; # 0..1 What artifact is being referenced
      fhir:resourceReference [ Reference ] ; # 0..1 What artifact, if not a conformance resource
    ] ... ) ;
    fhir:publicationForm ( [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations
      fhir:publishedIn [ # 0..1 The collection the cited article or artifact is published in
        fhir:type [ CodeableConcept ] ; # 0..1 Kind of container (e.g. Periodical, database, or book)
        fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
        fhir:title [ string ] ; # 0..1 Name of the database or title of the book or journal
        fhir:publisher [ Reference(Organization) ] ; # 0..1 Name of or resource describing the publisher
        fhir:publisherLocation [ string ] ; # 0..1 Geographic location of the publisher
      ] ;
      fhir:citedMedium [ CodeableConcept ] ; # 0..1 Internet or Print
      fhir:volume [ string ] ; # 0..1 Volume number of journal or other collection in which the article is published
      fhir:issue [ string ] ; # 0..1 Issue, part or supplement of journal or other collection in which the article is published
      fhir:articleDate [ dateTime ] ; # 0..1 The date the article was added to the database, or the date the article was released
      fhir:publicationDateText [ string ] ; # 0..1 Text representation of the date on which the issue of the cited artifact was published
      fhir:publicationDateSeason [ string ] ; # 0..1 Season in which the cited artifact was published
      fhir:lastRevisionDate [ dateTime ] ; # 0..1 The date the article was last revised or updated in the database
      fhir:language  ( [ CodeableConcept ] ... ) ; # 0..* Language(s) in which this form of the article is published
      fhir:accessionNumber [ string ] ; # 0..1 Entry number or identifier for inclusion in a database
      fhir:pageString [ string ] ; # 0..1 Used for full display of pagination
      fhir:firstPage [ string ] ; # 0..1 Used for isolated representation of first page
      fhir:lastPage [ string ] ; # 0..1 Used for isolated representation of last page
      fhir:pageCount [ string ] ; # 0..1 Number of pages or screens
      fhir:copyright [ markdown ] ; # 0..1 Copyright notice for the full article or artifact
    ] ... ) ;
    fhir:webLocation ( [ # 0..* Used for any URL for the article or artifact cited
      fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* Code the reason for different URLs, e.g. abstract and full-text
      fhir:url [ uri ] ; # 0..1 The specific URL
    ] ... ) ;
    fhir:classification ( [ # 0..* The assignment to an organizing scheme
      fhir:type [ CodeableConcept ] ; # 0..1 The kind of classifier (e.g. publication type, keyword)
      fhir:classifier  ( [ CodeableConcept ] ... ) ; # 0..* The specific classification value
      fhir:artifactAssessment  ( [ Reference(ArtifactAssessment) ] ... ) ; # 0..* Complex or externally created classification
    ] ... ) ;
    fhir:contributorship [ # 0..1 Attribution of authors and other contributors
      fhir:complete [ boolean ] ; # 0..1 Indicates if the list includes all authors and/or contributors
      fhir:entry ( [ # 0..* An individual entity named as a contributor
        fhir:contributor [ Reference(Organization|Practitioner) ] ; # 1..1 The identity of the individual contributor
        fhir:forenameInitials [ string ] ; # 0..1 For citation styles that use initials
        fhir:affiliation  ( [ Reference(Organization|PractitionerRole) ] ... ) ; # 0..* Organizational affiliation
        fhir:contributionType  ( [ CodeableConcept ] ... ) ; # 0..* The specific contribution
        fhir:role [ CodeableConcept ] ; # 0..1 The role of the contributor (e.g. author, editor, reviewer, funder)
        fhir:contributionInstance ( [ # 0..* Contributions with accounting for time or number
          fhir:type [ CodeableConcept ] ; # 1..1 The specific contribution
          fhir:time [ dateTime ] ; # 0..1 The time that the contribution was made
        ] ... ) ;
        fhir:correspondingContact [ boolean ] ; # 0..1 Whether the contributor is the corresponding contributor for the role
        fhir:rankingOrder [ positiveInt ] ; # 0..1 Ranked order of contribution
      ] ... ) ;
      fhir:summary ( [ # 0..* Used to record a display of the author/contributor list without separate data element for each list member
        fhir:type [ CodeableConcept ] ; # 0..1 Such as author list, contributorship statement, funding statement, acknowledgements statement, or conflicts of interest statement
        fhir:style [ CodeableConcept ] ; # 0..1 The format for the display string
        fhir:source [ CodeableConcept ] ; # 0..1 Used to code the producer or rule for creating the display string
        fhir:value [ markdown ] ; # 1..1 The display string for the author list, contributor list, or contributorship statement
      ] ... ) ;
    ] ;
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Any additional information or content for the article or artifact
  ] ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML JSON, XML Schema/Schematron JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

14.12.4.1 Terminology Bindings

Path ValueSet Type Documentation
Citation.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.
Citation.status PublicationStatus Required

The lifecycle status of an artifact.
Citation.jurisdiction JurisdictionValueSet Extensible

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 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
Citation.summary.style CitationSummaryStyle Extensible

The format for display of the citation.
Citation.classification.type CitationClassificationType Extensible

Citation classification type
Citation.classification.classifier CitationArtifactClassifier Example

Citation artifact classifier
Citation.currentState CitationStatusType Example

Citation status type
Citation.statusDate.activity CitationStatusType Example

Citation status type
Citation.citedArtifact.currentState CitedArtifactStatusType Extensible

Cited Artifact Status Type
Citation.citedArtifact.statusDate.activity CitedArtifactStatusType Extensible

Cited Artifact Status Type
Citation.citedArtifact.title.type TitleType Extensible

Used to express the reason and specific aspect for the variant title, such as language and specific language.
Citation.citedArtifact.title.language CommonLanguages Preferred

This value set includes common codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
Citation.citedArtifact.abstract.type CitedArtifactAbstractType Extensible

Used to express the reason and specific aspect for the variant abstract, such as language and specific language.
Citation.citedArtifact.abstract.language CommonLanguages Preferred

This value set includes common codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
Citation.citedArtifact.part.type CitedArtifactPartType Extensible

To describe the reason for the variant citation, such as version number or subpart specification.
Citation.citedArtifact.relatesTo.type RelatedArtifactTypeExpanded Required

The type of relationship to the cited artifact.
Citation.citedArtifact.relatesTo.classifier CitationArtifactClassifier Extensible

Citation artifact classifier
Citation.citedArtifact.publicationForm.publishedIn.type PublishedInType Extensible

The type of publication such as book, database, or journal.
Citation.citedArtifact.publicationForm.citedMedium CitedMedium Extensible

NLM codes Internet or Print.
Citation.citedArtifact.publicationForm.language CommonLanguages Preferred

This value set includes common codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
Citation.citedArtifact.webLocation.classifier ArtifactUrlClassifier Extensible

Code the reason for different URLs, eg abstract and full-text.
Citation.citedArtifact.classification.type CitedArtifactClassificationType Extensible

Cited Artifact Classification Type
Citation.citedArtifact.classification.classifier CitationArtifactClassifier Example

Citation artifact classifier
Citation.citedArtifact.contributorship.entry.contributionType ArtifactContributionType Extensible

Citation contribution.
Citation.citedArtifact.contributorship.entry.role ContributorRole Extensible

Used to code the format of the display string.
Citation.citedArtifact.contributorship.entry.contributionInstance.type ArtifactContributionInstanceType Extensible

Artifact Contribution Instance Type
Citation.citedArtifact.contributorship.summary.type ContributorSummaryType Extensible

Used to code author list statement, contributorship statement, and such.
Citation.citedArtifact.contributorship.summary.style ContributorSummaryStyle Extensible

Used to code the format of the display string.
Citation.citedArtifact.contributorship.summary.source ContributorSummarySource Extensible

Used to code the producer or rule for creating the display string.

14.12.4.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning Citation.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ] $')



14.12.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to 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
classification composite A classification type and value assigned to the citation On Citation.classification:
  classification-type: type
  classifier: classifier
classification-type token A type of classification assigned to the citation (Citation.classification.type)
classifier token A classifier assigned to the citation (Citation.classification.classifier)
context token A use context assigned to the citation (Citation.useContext.value.ofType(CodeableConcept)) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the citation (Citation.useContext.value.ofType(Quantity)) | (Citation.useContext.value.ofType(Range)) 30 Resources
context-type token A type of use context assigned to the citation Citation.useContext.code 30 Resources
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: value.ofType(Quantity) | value.ofType(Range)		 30 Resources
context-type-value composite A use context type and value assigned to the citation On Citation.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		 30 Resources
date date The citation publication date Citation.date 30 Resources
description string The description of the citation Citation.description 28 Resources
effective date The time during which the citation is intended to be in use Citation.effectivePeriod 12 Resources
identifier token External identifier for the citation Citation.identifier 36 Resources
jurisdiction token Intended jurisdiction for the citation Citation.jurisdiction 26 Resources
name string Computationally friendly name of the citation Citation.name 27 Resources
publisher string Name of the publisher of the citation Citation.publisher 30 Resources
status token The current status of the citation Citation.status 36 Resources
title string The human-friendly name of the citation Citation.title 27 Resources
url uri The uri that identifies the citation Citation.url 35 Resources
version token The business version of the citation Citation.version 31 Resources