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: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.

Note to Balloters: FMG icon is presently considering whether this resource is appopriate to include in the FHIR specification. The resource covers domain content that is not considered specific to healthcare, and FMG is still discussing whether alternative standards organizations exist that should standardise this content, and whether HL7 does or can have the correct community representation to support standardizing this content. Feedback is welcome view ballot, or to FMG directly at fmgcontact@hl7.org

The FHIR Management Group has provisionally approved the Citation Resource with the qualification that we will continue to evaluate its appropriateness as it develops in the community.

The scope of the Citation Resource is to describe any aspect of identification, location, authorship, and contributorship to a journal article, report, document, resource, or other knowledge artifact. Citations are used extensively in scholarly communication and important for documenting the evidence or source behind statements of fact, opinion, and interpretation. Citations are also used for acknowledgement of the contributions of individuals and groups to the creation and advancement of knowledge.

Across the academic and scientific community citations are used extensively to reference the knowledge artifacts contributing to current work. For any community searching for reports of research or scholarly publications (such as searching MEDLINE) the citations contain the metadata used for such searches. Standardization of citations supports interoperability across citation managers and adaptation to current needs, such as reports being available on preprint servers before 'final' peer-reviewed published form, need to cite datasets or other alternative forms of expression, or the ability to support citation of FHIR Resources where the FHIR Resource represents research or scholarly publication.

The Resource can accommodate both human and machine readers. The summary element provides human-readable information.

The Citation Resource has multiple elements containing metadata that describe the citation resource itself, and a citedArtifact element containing metadata that describe the article or artifact being cited.

Attribution of scholarly contributions is expressed in the citedArtifact.contributorship element, which has grown more complex as the nature of authorship and the concerns for credit and acknowledgement are increasingly complex. If an individualized attribution structure is not required, the citedArtifact.contributorship.summary element will do.

"Publication" must now cover books, books series, article series, database registries, database updates, and the like. The element, citedArtifact.publicationForm, enables this description. Within citedArtifact.publicationForm, the publishedIn element identifies the largest container (journal, book, database, or newspaper), the periodicRelease element identifies the periodic issue, and the remaining elements (covering dates, language, and pagination) are specific to the artifact being cited.

Any resource may have common metadata including publisher, authors, reviewers, editors, endorsers, identifiers and location concepts for the resource. The Citation Resource is expected to be used primarily for citing things that are not FHIR Resources. There is NOT an expectation to provide Citations for most FHIR Resources. However, FHIR Resources can be the subject of Citation Resources when there is additional needs beyond common metadata to use the FHIR Resource as the cited source in other contexts or to support scholarly and scientific contribution attribution to the FHIR Resource content.

The Provenance Resource is used to track the contributions to a resource as it occurs, especially for purposes of confirming authenticity and trust. Citation.citedArtifact.contributorship is used to report the attribution of contributions to the cited artifact, especially for purposes of recognition and acknowledgement, but is not directly reporting the data to support authenticity of the contributions.

The DocumentReference Resource is described as a reference to a document of any kind for any purpose. As the DocumentReference Resource was developed for healthcare data exchange it is modeled to support individualized provenance, security, and artifact relationships as often needed in this context. The Citation Resource was developed for the reference to knowledge artifacts commonly used in scientific and scholarly communication so is modeled to support identification, attribution, classification, status tracking, and representation (summary) of the citation.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation TUDomainResourceA 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 ΣC0..1uriCanonical identifier for this citation, represented as a globally unique URI
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierIdentifier for the Citation resource itself

... version Σ0..1stringBusiness version of the citation
... name ΣC0..1stringName for this citation (computer friendly)
... title Σ0..1stringName for this citation (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringThe publisher of the Citation, not the publisher of the article or artifact being cited
... contact Σ0..*ContactDetailContact details for the publisher of the Citation Resource

... description 0..1markdownNatural language description of the citation
... useContext Σ0..*UsageContextThe context that the Citation Resource content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for citation (if applicable)
Jurisdiction ValueSet (Extensible)

... purpose 0..1markdownWhy this citation is defined
... copyright 0..1markdownUse and/or publishing restrictions for the Citation, not for the cited artifact
... approvalDate 0..1dateWhen the citation was approved by publisher
... lastReviewDate 0..1dateWhen the citation was last reviewed
... effectivePeriod Σ0..1PeriodWhen the citation is expected to be used
... author 0..*ContactDetailWho authored the Citation

... editor 0..*ContactDetailWho edited the Citation

... reviewer 0..*ContactDetailWho reviewed the Citation

... endorser 0..*ContactDetailWho endorsed the Citation

... summary 0..*BackboneElementA human-readable display of the citation

.... style 0..1CodeableConceptFormat for display of the citation
CitationSummaryStyle (Extensible)
.... text Σ1..1markdownThe human-readable display of the citation
... classification 0..*BackboneElementThe assignment to an organizing scheme

.... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
CitationClassificationType (Extensible)
.... classifier 0..*CodeableConceptThe specific classification value
CitationArtifactClassifier (Example)

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

... currentState 0..*CodeableConceptThe status of the citation
CitationStatusType (Example)

... statusDate 0..*BackboneElementAn effective date or period for a status of the citation

.... activity 1..1CodeableConceptClassification of the status
CitationStatusType (Example)
.... actual 0..1booleanEither occurred or expected
.... period 1..1PeriodWhen the status started and/or ended
... relatedArtifact 0..*RelatedArtifactArtifact related to the Citation Resource

... citedArtifact 0..1BackboneElementThe article or artifact being described
.... identifier Σ0..*IdentifierMay include DOI, PMID, PMCID, etc.

.... relatedIdentifier Σ0..*IdentifierMay include trial registry identifiers

.... dateAccessed Σ0..1dateTimeWhen the cited artifact was accessed
.... version 0..1BackboneElementThe defined version of the cited artifact
..... value 1..1stringThe version number or other version identifier
..... baseCitation 0..1Reference(Citation)Citation for the main version of the cited artifact
.... currentState 0..*CodeableConceptThe status of the cited artifact
CitedArtifactStatusType (Extensible)

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

..... activity 1..1CodeableConceptClassification of the status
CitedArtifactStatusType (Extensible)
..... actual 0..1booleanEither occurred or expected
..... period 1..1PeriodWhen the status started and/or ended
.... title 0..*BackboneElementThe title details of the article or artifact

..... type 0..*CodeableConceptThe kind of title
TitleType (Extensible)

..... language 0..1CodeableConceptUsed to express the specific language
Common Languages (Preferred)
..... text 1..1markdownThe title of the article or artifact
.... abstract 0..*BackboneElementSummary of the article or artifact

..... type 0..1CodeableConceptThe kind of abstract
CitedArtifactAbstractType (Extensible)
..... language 0..1CodeableConceptUsed to express the specific language
Common Languages (Preferred)
..... text 1..1markdownAbstract content
..... copyright 0..1markdownCopyright notice for the abstract
.... part 0..1BackboneElementThe component of the article or artifact
..... type 0..1CodeableConceptThe kind of component
CitedArtifactPartType (Extensible)
..... value 0..1stringThe specification of the component
..... baseCitation 0..1Reference(Citation)The citation for the full article or artifact
.... relatesTo 0..*BackboneElementThe artifact related to the cited artifact

..... type 1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
RelatedArtifactTypeExpanded (Required)
..... classifier 0..*CodeableConceptAdditional classifiers
CitationArtifactClassifier (Extensible)

..... label 0..1stringShort label
..... display 0..1stringBrief description of the related artifact
..... citation 0..1markdownBibliographic citation for the artifact
..... document 0..1AttachmentWhat document is being referenced
..... resource 0..1canonical()What artifact is being referenced
..... resourceReference 0..1Reference()What artifact, if not a conformance resource
.... publicationForm 0..*BackboneElementIf multiple, used to represent alternative forms of the article that are not separate citations

..... publishedIn 0..1BackboneElementThe collection the cited article or artifact is published in
...... type 0..1CodeableConceptKind of container (e.g. Periodical, database, or book)
PublishedInType (Extensible)
...... identifier 0..*IdentifierJournal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN

...... title 0..1stringName of the database or title of the book or journal
...... publisher 0..1Reference(Organization)Name of the publisher
...... publisherLocation 0..1stringGeographic location of the publisher
..... citedMedium 0..1CodeableConceptInternet or Print
CitedMedium (Extensible)
..... volume 0..1stringVolume number of journal in which the article is published
..... issue 0..1stringIssue, part or supplement of journal in which the article is published
..... publicationDateYear 0..1stringYear on which the issue of the journal was published
..... publicationDateMonth 0..1stringMonth on which the issue of the journal was published
..... publicationDateDay 0..1stringDay on which the issue of the journal was published
..... publicationDateSeason 0..1stringSeason on which the issue of the journal was published
..... publicationDateText 0..1stringText representation of the date of which the issue of the journal was published
..... articleDate 0..1dateTimeThe date the article was added to the database, or the date the article was released
..... lastRevisionDate 0..1dateTimeThe date the article was last revised or updated in the database
..... language 0..*CodeableConceptLanguage in which this form of the article is published
Common Languages (Preferred)

..... accessionNumber 0..1stringEntry number or identifier for inclusion in a database
..... pageString 0..1stringUsed for full display of pagination
..... firstPage 0..1stringUsed for isolated representation of first page
..... lastPage 0..1stringUsed for isolated representation of last page
..... pageCount 0..1stringNumber of pages or screens
..... copyright 0..1markdownCopyright notice for the full article or artifact
.... webLocation 0..*BackboneElementUsed for any URL for the article or artifact cited

..... classifier 0..*CodeableConceptCode the reason for different URLs, e.g. abstract and full-text
ArtifactUrlClassifier (Extensible)

..... url 0..1uriThe specific URL
.... classification 0..*BackboneElementThe assignment to an organizing scheme

..... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
CitedArtifactClassificationType (Extensible)
..... classifier 0..*CodeableConceptThe specific classification value
CitationArtifactClassifier (Example)

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

.... contributorship 0..1BackboneElementAttribution of authors and other contributors
..... complete 0..1booleanIndicates if the list includes all authors and/or contributors
..... entry 0..*BackboneElementAn individual entity named in the list

...... contributor 1..1Reference(Practitioner | Organization)The identity of the individual entity
...... forenameInitials 0..1stringInitials for forename
...... affiliation 0..*Reference(Organization | PractitionerRole)Organizational affiliation

...... contributionType 0..*CodeableConceptThe specific contribution
ArtifactContributionType (Extensible)

...... role 0..1CodeableConceptThe role of the contributor (e.g. author, editor, reviewer)
ContributorRole (Extensible)
...... contributionInstance 0..*BackboneElementContributions with accounting for time or number

....... type 1..1CodeableConceptThe specific contribution
ArtifactContributionInstanceType (Extensible)
....... time 0..1dateTimeThe time that the contribution was made
...... correspondingContact 0..1booleanIndication of which contributor is the corresponding contributor for the role
...... rankingOrder 0..1positiveIntRanked order of contribution
..... summary 0..*BackboneElementUsed to record a display of the author/contributor list without separate coding for each list member

...... type 0..1CodeableConceptEither authorList or contributorshipStatement
ContributorSummaryType (Extensible)
...... style 0..1CodeableConceptThe format for the display string
ContributorSummaryStyle (Extensible)
...... source 0..1CodeableConceptUsed to code the producer or rule for creating the display string
ContributorSummarySource (Extensible)
...... value 1..1markdownThe display string for the author list, contributor list, or contributorship statement
.... note 0..*AnnotationAny additional information or content for the article or artifact


doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

Citation (DomainResource) +MetadataResourceAn absolute URI that is used to identify this citation 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 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 when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation 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]A natural language name identifying the citation. 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 citationtitle : 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 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 was published. 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 changesdate : dateTime [0..1]The name of the organization or individual that published the citationpublisher : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the citation 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, not for the cited artifactcopyright : markdown [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 content was or is planned to be in active useeffectivePeriod : Period [0..1]Who authored the Citationauthor : ContactDetail [0..*]Who edited the Citationeditor : ContactDetail [0..*]Who reviewed the Citationreviewer : ContactDetail [0..*]Who endorsed the Citationendorser : ContactDetail [0..*]Used for general notes and annotations not coded elsewherenote : Annotation [0..*]The status of the citationcurrentState : CodeableConcept [0..*] « null (Strength=Example)CitationStatusType?? »Artifact related to the Citation ResourcerelatedArtifact : RelatedArtifact [0..*]SummaryFormat for display of the citationstyle : CodeableConcept [0..1] « null (Strength=Extensible)CitationSummaryStyle+ »The human-readable display of the citationtext : 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?? »StatusDateClassification of the statusactivity : CodeableConcept [1..1] « null (Strength=Example)CitationStatusType?? »Either occurred or expectedactual : boolean [0..1]When the status started and/or endedperiod : Period [1..1]CitedArtifactA formal identifier that is used to identify this citation 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 this citationrelatedIdentifier : 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 »StatusDateClassification of the statusactivity : 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 or specific aspect for the titletype : CodeableConcept [0..*] « null (Strength=Extensible)TitleType+ »Used to express the specific languagelanguage : CodeableConcept [0..1] « null (Strength=Preferred)CommonLanguages? »The title of the article or artifacttext : markdown [1..1]AbstractUsed to express the reason or specific aspect for the abstracttype : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactAbstractType+ »Used to express the specific languagelanguage : CodeableConcept [0..1] « null (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 citation 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. This is exclusive with the resource elementdocument : 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"citedMedium : CodeableConcept [0..1] « null (Strength=Extensible)CitedMedium+ »Volume number of journal in which the article is publishedvolume : string [0..1]Issue, part or supplement of journal in which the article is publishedissue : string [0..1]Year on which the issue of the journal was publishedpublicationDateYear : string [0..1]Month on which the issue of the journal was publishedpublicationDateMonth : string [0..1]Day on which the issue of the journal was publishedpublicationDateDay : string [0..1]Spring, Summer, Fall/Autumn, WinterpublicationDateSeason : string [0..1]Text representation of the date of which the issue of the journal was publishedpublicationDateText : string [0..1]The date the article was added to the database, or the date the article was released (which may differ from the journal issue publication date)articleDate : dateTime [0..1]The date the article was last revised or updated in the databaselastRevisionDate : dateTime [0..1]Language in which this form of the article is publishedlanguage : CodeableConcept [0..*] « null (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 screenspageCount : 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 the publisherpublisher : Reference [0..1] « Organization »Geographic location of the publisherpublisherLocation : string [0..1]WebLocationCode the reason for different URLs, e.g. abstract and full-textclassifier : 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 entitycontributor : Reference [1..1] « Practitioner|Organization »Initials for forenameforenameInitials : string [0..1]Organization affiliated with the entityaffiliation : 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)role : CodeableConcept [0..1] « null (Strength=Extensible)ContributorRole+ »Indication of which 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 stringstyle : 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 the citationsummary[0..*]The assignment to an organizing schemeclassification[0..*]An effective date or period for a status of the citationstatusDate[0..*]The defined version of the cited artifactversion[0..1]An effective date or period for a status of the cited artifactstatusDate[0..*]The title details of the article or artifacttitle[0..*]Summary of the article or artifactabstract[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 in the author list or contributor listentry[0..*]Used to record a display of the author/contributor list without separate coding 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, represented as a globally unique URI -->
 <identifier><!-- 0..* Identifier Identifier for the Citation resource itself --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the citation -->
 <name value="[string]"/><!-- I 0..1 Name for this citation (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this citation (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher of the Citation Resource --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the citation -->
 <useContext><!-- 0..* UsageContext The context that the Citation Resource content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for citation (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this citation is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact -->
 <approvalDate value="[date]"/><!-- 0..1 When the citation was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the citation was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the citation is expected to be used --></effectivePeriod>
 <author><!-- 0..* ContactDetail Who authored the Citation --></author>
 <editor><!-- 0..* ContactDetail Who edited the Citation --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the Citation --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the Citation --></endorser>
 <summary>  <!-- 0..* A human-readable display of the citation -->
  <style><!-- 0..1 CodeableConcept Format for display of the citation --></style>
  <text value="[markdown]"/><!-- 1..1 The human-readable display of the citation -->
 </summary>
 <classification>  <!-- 0..* The assignment to an organizing scheme -->
  <type><!-- 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword) --></type>
  <classifier><!-- 0..* CodeableConcept The specific classification value --></classifier>
 </classification>
 <note><!-- 0..* Annotation Used for general notes and annotations not coded elsewhere --></note>
 <currentState><!-- 0..* CodeableConcept The status of the citation --></currentState>
 <statusDate>  <!-- 0..* An effective date or period for a status of the citation -->
  <activity><!-- 1..1 CodeableConcept Classification of the status --></activity>
  <actual value="[boolean]"/><!-- 0..1 Either occurred or expected -->
  <period><!-- 1..1 Period When the status started and/or ended --></period>
 </statusDate>
 <relatedArtifact><!-- 0..* RelatedArtifact Artifact related to the Citation Resource --></relatedArtifact>
 <citedArtifact>  <!-- 0..1 The article or artifact being described -->
  <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier>
  <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier>
  <dateAccessed value="[dateTime]"/><!-- 0..1 When the cited artifact was accessed -->
  <version>  <!-- 0..1 The defined version of the cited artifact -->
   <value value="[string]"/><!-- 1..1 The version number or other version identifier -->
   <baseCitation><!-- 0..1 Reference(Citation) Citation for the main version of the cited artifact --></baseCitation>
  </version>
  <currentState><!-- 0..* CodeableConcept The status of the cited artifact --></currentState>
  <statusDate>  <!-- 0..* An effective date or period for a status of the cited artifact -->
   <activity><!-- 1..1 CodeableConcept Classification of the status --></activity>
   <actual value="[boolean]"/><!-- 0..1 Either occurred or expected -->
   <period><!-- 1..1 Period When the status started and/or ended --></period>
  </statusDate>
  <title>  <!-- 0..* The title details of the article or artifact -->
   <type><!-- 0..* CodeableConcept The kind of title --></type>
   <language><!-- 0..1 CodeableConcept Used to express the specific language --></language>
   <text value="[markdown]"/><!-- 1..1 The title of the article or artifact -->
  </title>
  <abstract>  <!-- 0..* Summary of the article or artifact -->
   <type><!-- 0..1 CodeableConcept The kind of abstract --></type>
   <language><!-- 0..1 CodeableConcept Used to express the specific language --></language>
   <text value="[markdown]"/><!-- 1..1 Abstract content -->
   <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the abstract -->
  </abstract>
  <part>  <!-- 0..1 The component of the article or artifact -->
   <type><!-- 0..1 CodeableConcept The kind of component --></type>
   <value value="[string]"/><!-- 0..1 The specification of the component -->
   <baseCitation><!-- 0..1 Reference(Citation) The citation for the full article or artifact --></baseCitation>
  </part>
  <relatesTo>  <!-- 0..* The artifact related to the cited artifact -->
   <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of -->
   <classifier><!-- 0..* CodeableConcept Additional classifiers --></classifier>
   <label value="[string]"/><!-- 0..1 Short label -->
   <display value="[string]"/><!-- 0..1 Brief description of the related artifact -->
   <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact -->
   <document><!-- 0..1 Attachment What document is being referenced --></document>
   <resource value="[canonical]"/><!-- 0..1 What artifact is being referenced -->
   <resourceReference><!-- 0..1 Reference What artifact, if not a conformance resource --></resourceReference>
  </relatesTo>
  <publicationForm>  <!-- 0..* If multiple, used to represent alternative forms of the article that are not separate citations -->
   <publishedIn>  <!-- 0..1 The collection the cited article or artifact is published in -->
    <type><!-- 0..1 CodeableConcept Kind of container (e.g. Periodical, database, or book) --></type>
    <identifier><!-- 0..* Identifier Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN --></identifier>
    <title value="[string]"/><!-- 0..1 Name of the database or title of the book or journal -->
    <publisher><!-- 0..1 Reference(Organization) Name of the publisher --></publisher>
    <publisherLocation value="[string]"/><!-- 0..1 Geographic location of the publisher -->
   </publishedIn>
   <citedMedium><!-- 0..1 CodeableConcept Internet or Print --></citedMedium>
   <volume value="[string]"/><!-- 0..1 Volume number of journal in which the article is published -->
   <issue value="[string]"/><!-- 0..1 Issue, part or supplement of journal in which the article is published -->
   <publicationDateYear value="[string]"/><!-- 0..1 Year on which the issue of the journal was published -->
   <publicationDateMonth value="[string]"/><!-- 0..1 Month on which the issue of the journal was published -->
   <publicationDateDay value="[string]"/><!-- 0..1 Day on which the issue of the journal was published -->
   <publicationDateSeason value="[string]"/><!-- 0..1 Season on which the issue of the journal was published -->
   <publicationDateText value="[string]"/><!-- 0..1 Text representation of the date of which the issue of the journal was published -->
   <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released -->
   <lastRevisionDate value="[dateTime]"/><!-- 0..1 The date the article was last revised or updated in the database -->
   <language><!-- 0..* CodeableConcept Language in which this form of the article is published --></language>
   <accessionNumber value="[string]"/><!-- 0..1 Entry number or identifier for inclusion in a database -->
   <pageString value="[string]"/><!-- 0..1 Used for full display of pagination -->
   <firstPage value="[string]"/><!-- 0..1 Used for isolated representation of first page -->
   <lastPage value="[string]"/><!-- 0..1 Used for isolated representation of last page -->
   <pageCount value="[string]"/><!-- 0..1 Number of pages or screens -->
   <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the full article or artifact -->
  </publicationForm>
  <webLocation>  <!-- 0..* Used for any URL for the article or artifact cited -->
   <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 in the list -->
    <contributor><!-- 1..1 Reference(Organization|Practitioner) The identity of the individual entity --></contributor>
    <forenameInitials value="[string]"/><!-- 0..1 Initials for forename -->
    <affiliation><!-- 0..* Reference(Organization|PractitionerRole) Organizational affiliation --></affiliation>
    <contributionType><!-- 0..* CodeableConcept The specific contribution --></contributionType>
    <role><!-- 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer) --></role>
    <contributionInstance>  <!-- 0..* Contributions with accounting for time or number -->
     <type><!-- 1..1 CodeableConcept The specific contribution --></type>
     <time value="[dateTime]"/><!-- 0..1 The time that the contribution was made -->
    </contributionInstance>
    <correspondingContact value="[boolean]"/><!-- 0..1 Indication of which contributor is the corresponding contributor for the role -->
    <rankingOrder value="[positiveInt]"/><!-- 0..1 Ranked order of contribution -->
   </entry>
   <summary>  <!-- 0..* Used to record a display of the author/contributor list without separate coding for each list member -->
    <type><!-- 0..1 CodeableConcept Either authorList or contributorshipStatement --></type>
    <style><!-- 0..1 CodeableConcept The format for the display string --></style>
    <source><!-- 0..1 CodeableConcept Used to code the producer or rule for creating the display string --></source>
    <value value="[markdown]"/><!-- 1..1 The display string for the author list, contributor list, or contributorship statement -->
   </summary>
  </contributorship>
  <note><!-- 0..* Annotation Any additional information or content for the article or artifact --></note>
 </citedArtifact>
</Citation>

JSON Template

{doco
  "resourceType" : "Citation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this citation, represented as a globally unique URI
  "identifier" : [{ Identifier }], // Identifier for the Citation resource itself
  "version" : "<string>", // Business version of the citation
  "name" : "<string>", // I Name for this citation (computer friendly)
  "title" : "<string>", // Name for this citation (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // The publisher of the Citation, not the publisher of the article or artifact being cited
  "contact" : [{ ContactDetail }], // Contact details for the publisher of the Citation Resource
  "description" : "<markdown>", // Natural language description of the citation
  "useContext" : [{ UsageContext }], // The context that the Citation Resource content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation (if applicable)
  "purpose" : "<markdown>", // Why this citation is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions for the Citation, not for the cited artifact
  "approvalDate" : "<date>", // When the citation was approved by publisher
  "lastReviewDate" : "<date>", // When the citation was last reviewed
  "effectivePeriod" : { Period }, // When the citation is expected to be used
  "author" : [{ ContactDetail }], // Who authored the Citation
  "editor" : [{ ContactDetail }], // Who edited the Citation
  "reviewer" : [{ ContactDetail }], // Who reviewed the Citation
  "endorser" : [{ ContactDetail }], // Who endorsed the Citation
  "summary" : [{ // A human-readable display of the citation
    "style" : { CodeableConcept }, // Format for display of the citation
    "text" : "<markdown>" // R!  The human-readable display of the citation
  }],
  "classification" : [{ // The assignment to an organizing scheme
    "type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
    "classifier" : [{ CodeableConcept }] // The specific classification value
  }],
  "note" : [{ Annotation }], // Used for general notes and annotations not coded elsewhere
  "currentState" : [{ CodeableConcept }], // The status of the citation
  "statusDate" : [{ // An effective date or period for a status of the citation
    "activity" : { CodeableConcept }, // R!  Classification of the status
    "actual" : <boolean>, // Either occurred or expected
    "period" : { Period } // R!  When the status started and/or ended
  }],
  "relatedArtifact" : [{ RelatedArtifact }], // Artifact related to the Citation Resource
  "citedArtifact" : { // The article or artifact being described
    "identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc.
    "relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers
    "dateAccessed" : "<dateTime>", // When the cited artifact was accessed
    "version" : { // The defined version of the cited artifact
      "value" : "<string>", // R!  The version number or other version identifier
      "baseCitation" : { Reference(Citation) } // Citation for the main version of the cited artifact
    },
    "currentState" : [{ CodeableConcept }], // The status of the cited artifact
    "statusDate" : [{ // An effective date or period for a status of the cited artifact
      "activity" : { CodeableConcept }, // R!  Classification of the status
      "actual" : <boolean>, // Either occurred or expected
      "period" : { Period } // R!  When the status started and/or ended
    }],
    "title" : [{ // The title details of the article or artifact
      "type" : [{ CodeableConcept }], // The kind of title
      "language" : { CodeableConcept }, // Used to express the specific language
      "text" : "<markdown>" // R!  The title of the article or artifact
    }],
    "abstract" : [{ // Summary of the article or artifact
      "type" : { CodeableConcept }, // The kind of abstract
      "language" : { CodeableConcept }, // Used to express the specific language
      "text" : "<markdown>", // R!  Abstract content
      "copyright" : "<markdown>" // Copyright notice for the abstract
    }],
    "part" : { // The component of the article or artifact
      "type" : { CodeableConcept }, // The kind of component
      "value" : "<string>", // The specification of the component
      "baseCitation" : { Reference(Citation) } // The citation for the full article or artifact
    },
    "relatesTo" : [{ // The artifact related to the cited artifact
      "type" : "<code>", // R!  documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
      "classifier" : [{ CodeableConcept }], // Additional classifiers
      "label" : "<string>", // Short label
      "display" : "<string>", // Brief description of the related artifact
      "citation" : "<markdown>", // Bibliographic citation for the artifact
      "document" : { Attachment }, // What document is being referenced
      "resource" : "<canonical>", // What artifact is being referenced
      "resourceReference" : { Reference } // What artifact, if not a conformance resource
    }],
    "publicationForm" : [{ // If multiple, used to represent alternative forms of the article that are not separate citations
      "publishedIn" : { // The collection the cited article or artifact is published in
        "type" : { CodeableConcept }, // Kind of container (e.g. Periodical, database, or book)
        "identifier" : [{ Identifier }], // Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
        "title" : "<string>", // Name of the database or title of the book or journal
        "publisher" : { Reference(Organization) }, // Name of the publisher
        "publisherLocation" : "<string>" // Geographic location of the publisher
      },
      "citedMedium" : { CodeableConcept }, // Internet or Print
      "volume" : "<string>", // Volume number of journal in which the article is published
      "issue" : "<string>", // Issue, part or supplement of journal in which the article is published
      "publicationDateYear" : "<string>", // Year on which the issue of the journal was published
      "publicationDateMonth" : "<string>", // Month on which the issue of the journal was published
      "publicationDateDay" : "<string>", // Day on which the issue of the journal was published
      "publicationDateSeason" : "<string>", // Season on which the issue of the journal was published
      "publicationDateText" : "<string>", // Text representation of the date of which the issue of the journal was published
      "articleDate" : "<dateTime>", // The date the article was added to the database, or the date the article was released
      "lastRevisionDate" : "<dateTime>", // The date the article was last revised or updated in the database
      "language" : [{ CodeableConcept }], // Language in which this form of the article is published
      "accessionNumber" : "<string>", // Entry number or identifier for inclusion in a database
      "pageString" : "<string>", // Used for full display of pagination
      "firstPage" : "<string>", // Used for isolated representation of first page
      "lastPage" : "<string>", // Used for isolated representation of last page
      "pageCount" : "<string>", // Number of pages or screens
      "copyright" : "<markdown>" // Copyright notice for the full article or artifact
    }],
    "webLocation" : [{ // Used for any URL for the article or artifact cited
      "classifier" : [{ CodeableConcept }], // Code the reason for different URLs, e.g. abstract and full-text
      "url" : "<uri>" // The specific URL
    }],
    "classification" : [{ // The assignment to an organizing scheme
      "type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
      "classifier" : [{ CodeableConcept }], // The specific classification value
      "artifactAssessment" : [{ Reference(ArtifactAssessment) }] // Complex or externally created classification

    }],
    "contributorship" : { // Attribution of authors and other contributors
      "complete" : <boolean>, // Indicates if the list includes all authors and/or contributors
      "entry" : [{ // An individual entity named in the list
        "contributor" : { Reference(Organization|Practitioner) }, // R!  The identity of the individual entity
        "forenameInitials" : "<string>", // Initials for forename
        "affiliation" : [{ Reference(Organization|PractitionerRole) }], // Organizational affiliation
        "contributionType" : [{ CodeableConcept }], // The specific contribution
        "role" : { CodeableConcept }, // The role of the contributor (e.g. author, editor, reviewer)
        "contributionInstance" : [{ // Contributions with accounting for time or number
          "type" : { CodeableConcept }, // R!  The specific contribution
          "time" : "<dateTime>" // The time that the contribution was made
        }],
        "correspondingContact" : <boolean>, // Indication of which contributor is the corresponding contributor for the role
        "rankingOrder" : "<positiveInt>" // Ranked order of contribution
      }],
      "summary" : [{ // Used to record a display of the author/contributor list without separate coding for each list member
        "type" : { CodeableConcept }, // Either authorList or contributorshipStatement
        "style" : { CodeableConcept }, // The format for the display string
        "source" : { CodeableConcept }, // Used to code the producer or rule for creating the display string
        "value" : "<markdown>" // R!  The display string for the author list, contributor list, or contributorship statement
      }]
    },
    "note" : [{ Annotation }] // Any additional information or content for the article or artifact
  }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .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:Citation.url [ uri ]; # 0..1 Canonical identifier for this citation, represented as a globally unique URI
  fhir:Citation.identifier [ Identifier ], ... ; # 0..* Identifier for the Citation resource itself
  fhir:Citation.version [ string ]; # 0..1 Business version of the citation
  fhir:Citation.name [ string ]; # 0..1 I Name for this citation (computer friendly)
  fhir:Citation.title [ string ]; # 0..1 Name for this citation (human friendly)
  fhir:Citation.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:Citation.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:Citation.date [ dateTime ]; # 0..1 Date last changed
  fhir:Citation.publisher [ string ]; # 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited
  fhir:Citation.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher of the Citation Resource
  fhir:Citation.description [ markdown ]; # 0..1 Natural language description of the citation
  fhir:Citation.useContext [ UsageContext ], ... ; # 0..* The context that the Citation Resource content is intended to support
  fhir:Citation.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for citation (if applicable)
  fhir:Citation.purpose [ markdown ]; # 0..1 Why this citation is defined
  fhir:Citation.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact
  fhir:Citation.approvalDate [ date ]; # 0..1 When the citation was approved by publisher
  fhir:Citation.lastReviewDate [ date ]; # 0..1 When the citation was last reviewed
  fhir:Citation.effectivePeriod [ Period ]; # 0..1 When the citation is expected to be used
  fhir:Citation.author [ ContactDetail ], ... ; # 0..* Who authored the Citation
  fhir:Citation.editor [ ContactDetail ], ... ; # 0..* Who edited the Citation
  fhir:Citation.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the Citation
  fhir:Citation.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the Citation
  fhir:Citation.summary [ # 0..* A human-readable display of the citation
    fhir:Citation.summary.style [ CodeableConcept ]; # 0..1 Format for display of the citation
    fhir:Citation.summary.text [ markdown ]; # 1..1 The human-readable display of the citation
  ], ...;
  fhir:Citation.classification [ # 0..* The assignment to an organizing scheme
    fhir:Citation.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword)
    fhir:Citation.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification value
  ], ...;
  fhir:Citation.note [ Annotation ], ... ; # 0..* Used for general notes and annotations not coded elsewhere
  fhir:Citation.currentState [ CodeableConcept ], ... ; # 0..* The status of the citation
  fhir:Citation.statusDate [ # 0..* An effective date or period for a status of the citation
    fhir:Citation.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status
    fhir:Citation.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected
    fhir:Citation.statusDate.period [ Period ]; # 1..1 When the status started and/or ended
  ], ...;
  fhir:Citation.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Artifact related to the Citation Resource
  fhir:Citation.citedArtifact [ # 0..1 The article or artifact being described
    fhir:Citation.citedArtifact.identifier [ Identifier ], ... ; # 0..* May include DOI, PMID, PMCID, etc.
    fhir:Citation.citedArtifact.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers
    fhir:Citation.citedArtifact.dateAccessed [ dateTime ]; # 0..1 When the cited artifact was accessed
    fhir:Citation.citedArtifact.version [ # 0..1 The defined version of the cited artifact
      fhir:Citation.citedArtifact.version.value [ string ]; # 1..1 The version number or other version identifier
      fhir:Citation.citedArtifact.version.baseCitation [ Reference(Citation) ]; # 0..1 Citation for the main version of the cited artifact
    ];
    fhir:Citation.citedArtifact.currentState [ CodeableConcept ], ... ; # 0..* The status of the cited artifact
    fhir:Citation.citedArtifact.statusDate [ # 0..* An effective date or period for a status of the cited artifact
      fhir:Citation.citedArtifact.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status
      fhir:Citation.citedArtifact.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected
      fhir:Citation.citedArtifact.statusDate.period [ Period ]; # 1..1 When the status started and/or ended
    ], ...;
    fhir:Citation.citedArtifact.title [ # 0..* The title details of the article or artifact
      fhir:Citation.citedArtifact.title.type [ CodeableConcept ], ... ; # 0..* The kind of title
      fhir:Citation.citedArtifact.title.language [ CodeableConcept ]; # 0..1 Used to express the specific language
      fhir:Citation.citedArtifact.title.text [ markdown ]; # 1..1 The title of the article or artifact
    ], ...;
    fhir:Citation.citedArtifact.abstract [ # 0..* Summary of the article or artifact
      fhir:Citation.citedArtifact.abstract.type [ CodeableConcept ]; # 0..1 The kind of abstract
      fhir:Citation.citedArtifact.abstract.language [ CodeableConcept ]; # 0..1 Used to express the specific language
      fhir:Citation.citedArtifact.abstract.text [ markdown ]; # 1..1 Abstract content
      fhir:Citation.citedArtifact.abstract.copyright [ markdown ]; # 0..1 Copyright notice for the abstract
    ], ...;
    fhir:Citation.citedArtifact.part [ # 0..1 The component of the article or artifact
      fhir:Citation.citedArtifact.part.type [ CodeableConcept ]; # 0..1 The kind of component
      fhir:Citation.citedArtifact.part.value [ string ]; # 0..1 The specification of the component
      fhir:Citation.citedArtifact.part.baseCitation [ Reference(Citation) ]; # 0..1 The citation for the full article or artifact
    ];
    fhir:Citation.citedArtifact.relatesTo [ # 0..* The artifact related to the cited artifact
      fhir:Citation.citedArtifact.relatesTo.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
      fhir:Citation.citedArtifact.relatesTo.classifier [ CodeableConcept ], ... ; # 0..* Additional classifiers
      fhir:Citation.citedArtifact.relatesTo.label [ string ]; # 0..1 Short label
      fhir:Citation.citedArtifact.relatesTo.display [ string ]; # 0..1 Brief description of the related artifact
      fhir:Citation.citedArtifact.relatesTo.citation [ markdown ]; # 0..1 Bibliographic citation for the artifact
      fhir:Citation.citedArtifact.relatesTo.document [ Attachment ]; # 0..1 What document is being referenced
      fhir:Citation.citedArtifact.relatesTo.resource [ canonical ]; # 0..1 What artifact is being referenced
      fhir:Citation.citedArtifact.relatesTo.resourceReference [ Reference ]; # 0..1 What artifact, if not a conformance resource
    ], ...;
    fhir:Citation.citedArtifact.publicationForm [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations
      fhir:Citation.citedArtifact.publicationForm.publishedIn [ # 0..1 The collection the cited article or artifact is published in
        fhir:Citation.citedArtifact.publicationForm.publishedIn.type [ CodeableConcept ]; # 0..1 Kind of container (e.g. Periodical, database, or book)
        fhir:Citation.citedArtifact.publicationForm.publishedIn.identifier [ Identifier ], ... ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
        fhir:Citation.citedArtifact.publicationForm.publishedIn.title [ string ]; # 0..1 Name of the database or title of the book or journal
        fhir:Citation.citedArtifact.publicationForm.publishedIn.publisher [ Reference(Organization) ]; # 0..1 Name of the publisher
        fhir:Citation.citedArtifact.publicationForm.publishedIn.publisherLocation [ string ]; # 0..1 Geographic location of the publisher
      ];
      fhir:Citation.citedArtifact.publicationForm.citedMedium [ CodeableConcept ]; # 0..1 Internet or Print
      fhir:Citation.citedArtifact.publicationForm.volume [ string ]; # 0..1 Volume number of journal in which the article is published
      fhir:Citation.citedArtifact.publicationForm.issue [ string ]; # 0..1 Issue, part or supplement of journal in which the article is published
      fhir:Citation.citedArtifact.publicationForm.publicationDateYear [ string ]; # 0..1 Year on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateMonth [ string ]; # 0..1 Month on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateDay [ string ]; # 0..1 Day on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateSeason [ string ]; # 0..1 Season on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateText [ string ]; # 0..1 Text representation of the date of which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.articleDate [ dateTime ]; # 0..1 The date the article was added to the database, or the date the article was released
      fhir:Citation.citedArtifact.publicationForm.lastRevisionDate [ dateTime ]; # 0..1 The date the article was last revised or updated in the database
      fhir:Citation.citedArtifact.publicationForm.language [ CodeableConcept ], ... ; # 0..* Language in which this form of the article is published
      fhir:Citation.citedArtifact.publicationForm.accessionNumber [ string ]; # 0..1 Entry number or identifier for inclusion in a database
      fhir:Citation.citedArtifact.publicationForm.pageString [ string ]; # 0..1 Used for full display of pagination
      fhir:Citation.citedArtifact.publicationForm.firstPage [ string ]; # 0..1 Used for isolated representation of first page
      fhir:Citation.citedArtifact.publicationForm.lastPage [ string ]; # 0..1 Used for isolated representation of last page
      fhir:Citation.citedArtifact.publicationForm.pageCount [ string ]; # 0..1 Number of pages or screens
      fhir:Citation.citedArtifact.publicationForm.copyright [ markdown ]; # 0..1 Copyright notice for the full article or artifact
    ], ...;
    fhir:Citation.citedArtifact.webLocation [ # 0..* Used for any URL for the article or artifact cited
      fhir:Citation.citedArtifact.webLocation.classifier [ CodeableConcept ], ... ; # 0..* Code the reason for different URLs, e.g. abstract and full-text
      fhir:Citation.citedArtifact.webLocation.url [ uri ]; # 0..1 The specific URL
    ], ...;
    fhir:Citation.citedArtifact.classification [ # 0..* The assignment to an organizing scheme
      fhir:Citation.citedArtifact.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword)
      fhir:Citation.citedArtifact.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification value
      fhir:Citation.citedArtifact.classification.artifactAssessment [ Reference(ArtifactAssessment) ], ... ; # 0..* Complex or externally created classification

    ], ...;
    fhir:Citation.citedArtifact.contributorship [ # 0..1 Attribution of authors and other contributors
      fhir:Citation.citedArtifact.contributorship.complete [ boolean ]; # 0..1 Indicates if the list includes all authors and/or contributors
      fhir:Citation.citedArtifact.contributorship.entry [ # 0..* An individual entity named in the list
        fhir:Citation.citedArtifact.contributorship.entry.contributor [ Reference(Organization|Practitioner) ]; # 1..1 The identity of the individual entity
        fhir:Citation.citedArtifact.contributorship.entry.forenameInitials [ string ]; # 0..1 Initials for forename
        fhir:Citation.citedArtifact.contributorship.entry.affiliation [ Reference(Organization|PractitionerRole) ], ... ; # 0..* Organizational affiliation
        fhir:Citation.citedArtifact.contributorship.entry.contributionType [ CodeableConcept ], ... ; # 0..* The specific contribution
        fhir:Citation.citedArtifact.contributorship.entry.role [ CodeableConcept ]; # 0..1 The role of the contributor (e.g. author, editor, reviewer)
        fhir:Citation.citedArtifact.contributorship.entry.contributionInstance [ # 0..* Contributions with accounting for time or number
          fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.type [ CodeableConcept ]; # 1..1 The specific contribution
          fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.time [ dateTime ]; # 0..1 The time that the contribution was made
        ], ...;
        fhir:Citation.citedArtifact.contributorship.entry.correspondingContact [ boolean ]; # 0..1 Indication of which contributor is the corresponding contributor for the role
        fhir:Citation.citedArtifact.contributorship.entry.rankingOrder [ positiveInt ]; # 0..1 Ranked order of contribution
      ], ...;
      fhir:Citation.citedArtifact.contributorship.summary [ # 0..* Used to record a display of the author/contributor list without separate coding for each list member
        fhir:Citation.citedArtifact.contributorship.summary.type [ CodeableConcept ]; # 0..1 Either authorList or contributorshipStatement
        fhir:Citation.citedArtifact.contributorship.summary.style [ CodeableConcept ]; # 0..1 The format for the display string
        fhir:Citation.citedArtifact.contributorship.summary.source [ CodeableConcept ]; # 0..1 Used to code the producer or rule for creating the display string
        fhir:Citation.citedArtifact.contributorship.summary.value [ markdown ]; # 1..1 The display string for the author list, contributor list, or contributorship statement
      ], ...;
    ];
    fhir:Citation.citedArtifact.note [ Annotation ], ... ; # 0..* Any additional information or content for the article or artifact
  ];
]

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Citation TUDomainResourceA 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 ΣC0..1uriCanonical identifier for this citation, represented as a globally unique URI
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierIdentifier for the Citation resource itself

... version Σ0..1stringBusiness version of the citation
... name ΣC0..1stringName for this citation (computer friendly)
... title Σ0..1stringName for this citation (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringThe publisher of the Citation, not the publisher of the article or artifact being cited
... contact Σ0..*ContactDetailContact details for the publisher of the Citation Resource

... description 0..1markdownNatural language description of the citation
... useContext Σ0..*UsageContextThe context that the Citation Resource content is intended to support

... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for citation (if applicable)
Jurisdiction ValueSet (Extensible)

... purpose 0..1markdownWhy this citation is defined
... copyright 0..1markdownUse and/or publishing restrictions for the Citation, not for the cited artifact
... approvalDate 0..1dateWhen the citation was approved by publisher
... lastReviewDate 0..1dateWhen the citation was last reviewed
... effectivePeriod Σ0..1PeriodWhen the citation is expected to be used
... author 0..*ContactDetailWho authored the Citation

... editor 0..*ContactDetailWho edited the Citation

... reviewer 0..*ContactDetailWho reviewed the Citation

... endorser 0..*ContactDetailWho endorsed the Citation

... summary 0..*BackboneElementA human-readable display of the citation

.... style 0..1CodeableConceptFormat for display of the citation
CitationSummaryStyle (Extensible)
.... text Σ1..1markdownThe human-readable display of the citation
... classification 0..*BackboneElementThe assignment to an organizing scheme

.... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
CitationClassificationType (Extensible)
.... classifier 0..*CodeableConceptThe specific classification value
CitationArtifactClassifier (Example)

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

... currentState 0..*CodeableConceptThe status of the citation
CitationStatusType (Example)

... statusDate 0..*BackboneElementAn effective date or period for a status of the citation

.... activity 1..1CodeableConceptClassification of the status
CitationStatusType (Example)
.... actual 0..1booleanEither occurred or expected
.... period 1..1PeriodWhen the status started and/or ended
... relatedArtifact 0..*RelatedArtifactArtifact related to the Citation Resource

... citedArtifact 0..1BackboneElementThe article or artifact being described
.... identifier Σ0..*IdentifierMay include DOI, PMID, PMCID, etc.

.... relatedIdentifier Σ0..*IdentifierMay include trial registry identifiers

.... dateAccessed Σ0..1dateTimeWhen the cited artifact was accessed
.... version 0..1BackboneElementThe defined version of the cited artifact
..... value 1..1stringThe version number or other version identifier
..... baseCitation 0..1Reference(Citation)Citation for the main version of the cited artifact
.... currentState 0..*CodeableConceptThe status of the cited artifact
CitedArtifactStatusType (Extensible)

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

..... activity 1..1CodeableConceptClassification of the status
CitedArtifactStatusType (Extensible)
..... actual 0..1booleanEither occurred or expected
..... period 1..1PeriodWhen the status started and/or ended
.... title 0..*BackboneElementThe title details of the article or artifact

..... type 0..*CodeableConceptThe kind of title
TitleType (Extensible)

..... language 0..1CodeableConceptUsed to express the specific language
Common Languages (Preferred)
..... text 1..1markdownThe title of the article or artifact
.... abstract 0..*BackboneElementSummary of the article or artifact

..... type 0..1CodeableConceptThe kind of abstract
CitedArtifactAbstractType (Extensible)
..... language 0..1CodeableConceptUsed to express the specific language
Common Languages (Preferred)
..... text 1..1markdownAbstract content
..... copyright 0..1markdownCopyright notice for the abstract
.... part 0..1BackboneElementThe component of the article or artifact
..... type 0..1CodeableConceptThe kind of component
CitedArtifactPartType (Extensible)
..... value 0..1stringThe specification of the component
..... baseCitation 0..1Reference(Citation)The citation for the full article or artifact
.... relatesTo 0..*BackboneElementThe artifact related to the cited artifact

..... type 1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
RelatedArtifactTypeExpanded (Required)
..... classifier 0..*CodeableConceptAdditional classifiers
CitationArtifactClassifier (Extensible)

..... label 0..1stringShort label
..... display 0..1stringBrief description of the related artifact
..... citation 0..1markdownBibliographic citation for the artifact
..... document 0..1AttachmentWhat document is being referenced
..... resource 0..1canonical()What artifact is being referenced
..... resourceReference 0..1Reference()What artifact, if not a conformance resource
.... publicationForm 0..*BackboneElementIf multiple, used to represent alternative forms of the article that are not separate citations

..... publishedIn 0..1BackboneElementThe collection the cited article or artifact is published in
...... type 0..1CodeableConceptKind of container (e.g. Periodical, database, or book)
PublishedInType (Extensible)
...... identifier 0..*IdentifierJournal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN

...... title 0..1stringName of the database or title of the book or journal
...... publisher 0..1Reference(Organization)Name of the publisher
...... publisherLocation 0..1stringGeographic location of the publisher
..... citedMedium 0..1CodeableConceptInternet or Print
CitedMedium (Extensible)
..... volume 0..1stringVolume number of journal in which the article is published
..... issue 0..1stringIssue, part or supplement of journal in which the article is published
..... publicationDateYear 0..1stringYear on which the issue of the journal was published
..... publicationDateMonth 0..1stringMonth on which the issue of the journal was published
..... publicationDateDay 0..1stringDay on which the issue of the journal was published
..... publicationDateSeason 0..1stringSeason on which the issue of the journal was published
..... publicationDateText 0..1stringText representation of the date of which the issue of the journal was published
..... articleDate 0..1dateTimeThe date the article was added to the database, or the date the article was released
..... lastRevisionDate 0..1dateTimeThe date the article was last revised or updated in the database
..... language 0..*CodeableConceptLanguage in which this form of the article is published
Common Languages (Preferred)

..... accessionNumber 0..1stringEntry number or identifier for inclusion in a database
..... pageString 0..1stringUsed for full display of pagination
..... firstPage 0..1stringUsed for isolated representation of first page
..... lastPage 0..1stringUsed for isolated representation of last page
..... pageCount 0..1stringNumber of pages or screens
..... copyright 0..1markdownCopyright notice for the full article or artifact
.... webLocation 0..*BackboneElementUsed for any URL for the article or artifact cited

..... classifier 0..*CodeableConceptCode the reason for different URLs, e.g. abstract and full-text
ArtifactUrlClassifier (Extensible)

..... url 0..1uriThe specific URL
.... classification 0..*BackboneElementThe assignment to an organizing scheme

..... type 0..1CodeableConceptThe kind of classifier (e.g. publication type, keyword)
CitedArtifactClassificationType (Extensible)
..... classifier 0..*CodeableConceptThe specific classification value
CitationArtifactClassifier (Example)

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

.... contributorship 0..1BackboneElementAttribution of authors and other contributors
..... complete 0..1booleanIndicates if the list includes all authors and/or contributors
..... entry 0..*BackboneElementAn individual entity named in the list

...... contributor 1..1Reference(Practitioner | Organization)The identity of the individual entity
...... forenameInitials 0..1stringInitials for forename
...... affiliation 0..*Reference(Organization | PractitionerRole)Organizational affiliation

...... contributionType 0..*CodeableConceptThe specific contribution
ArtifactContributionType (Extensible)

...... role 0..1CodeableConceptThe role of the contributor (e.g. author, editor, reviewer)
ContributorRole (Extensible)
...... contributionInstance 0..*BackboneElementContributions with accounting for time or number

....... type 1..1CodeableConceptThe specific contribution
ArtifactContributionInstanceType (Extensible)
....... time 0..1dateTimeThe time that the contribution was made
...... correspondingContact 0..1booleanIndication of which contributor is the corresponding contributor for the role
...... rankingOrder 0..1positiveIntRanked order of contribution
..... summary 0..*BackboneElementUsed to record a display of the author/contributor list without separate coding for each list member

...... type 0..1CodeableConceptEither authorList or contributorshipStatement
ContributorSummaryType (Extensible)
...... style 0..1CodeableConceptThe format for the display string
ContributorSummaryStyle (Extensible)
...... source 0..1CodeableConceptUsed to code the producer or rule for creating the display string
ContributorSummarySource (Extensible)
...... value 1..1markdownThe display string for the author list, contributor list, or contributorship statement
.... note 0..*AnnotationAny additional information or content for the article or artifact


doco Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

Citation (DomainResource) +MetadataResourceAn absolute URI that is used to identify this citation 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 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 when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation 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]A natural language name identifying the citation. 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 citationtitle : 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 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 was published. 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 changesdate : dateTime [0..1]The name of the organization or individual that published the citationpublisher : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the citation 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, not for the cited artifactcopyright : markdown [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 content was or is planned to be in active useeffectivePeriod : Period [0..1]Who authored the Citationauthor : ContactDetail [0..*]Who edited the Citationeditor : ContactDetail [0..*]Who reviewed the Citationreviewer : ContactDetail [0..*]Who endorsed the Citationendorser : ContactDetail [0..*]Used for general notes and annotations not coded elsewherenote : Annotation [0..*]The status of the citationcurrentState : CodeableConcept [0..*] « null (Strength=Example)CitationStatusType?? »Artifact related to the Citation ResourcerelatedArtifact : RelatedArtifact [0..*]SummaryFormat for display of the citationstyle : CodeableConcept [0..1] « null (Strength=Extensible)CitationSummaryStyle+ »The human-readable display of the citationtext : 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?? »StatusDateClassification of the statusactivity : CodeableConcept [1..1] « null (Strength=Example)CitationStatusType?? »Either occurred or expectedactual : boolean [0..1]When the status started and/or endedperiod : Period [1..1]CitedArtifactA formal identifier that is used to identify this citation 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 this citationrelatedIdentifier : 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 »StatusDateClassification of the statusactivity : 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 or specific aspect for the titletype : CodeableConcept [0..*] « null (Strength=Extensible)TitleType+ »Used to express the specific languagelanguage : CodeableConcept [0..1] « null (Strength=Preferred)CommonLanguages? »The title of the article or artifacttext : markdown [1..1]AbstractUsed to express the reason or specific aspect for the abstracttype : CodeableConcept [0..1] « null (Strength=Extensible)CitedArtifactAbstractType+ »Used to express the specific languagelanguage : CodeableConcept [0..1] « null (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 citation 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. This is exclusive with the resource elementdocument : 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"citedMedium : CodeableConcept [0..1] « null (Strength=Extensible)CitedMedium+ »Volume number of journal in which the article is publishedvolume : string [0..1]Issue, part or supplement of journal in which the article is publishedissue : string [0..1]Year on which the issue of the journal was publishedpublicationDateYear : string [0..1]Month on which the issue of the journal was publishedpublicationDateMonth : string [0..1]Day on which the issue of the journal was publishedpublicationDateDay : string [0..1]Spring, Summer, Fall/Autumn, WinterpublicationDateSeason : string [0..1]Text representation of the date of which the issue of the journal was publishedpublicationDateText : string [0..1]The date the article was added to the database, or the date the article was released (which may differ from the journal issue publication date)articleDate : dateTime [0..1]The date the article was last revised or updated in the databaselastRevisionDate : dateTime [0..1]Language in which this form of the article is publishedlanguage : CodeableConcept [0..*] « null (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 screenspageCount : 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 the publisherpublisher : Reference [0..1] « Organization »Geographic location of the publisherpublisherLocation : string [0..1]WebLocationCode the reason for different URLs, e.g. abstract and full-textclassifier : 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 entitycontributor : Reference [1..1] « Practitioner|Organization »Initials for forenameforenameInitials : string [0..1]Organization affiliated with the entityaffiliation : 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)role : CodeableConcept [0..1] « null (Strength=Extensible)ContributorRole+ »Indication of which 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 stringstyle : 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 the citationsummary[0..*]The assignment to an organizing schemeclassification[0..*]An effective date or period for a status of the citationstatusDate[0..*]The defined version of the cited artifactversion[0..1]An effective date or period for a status of the cited artifactstatusDate[0..*]The title details of the article or artifacttitle[0..*]Summary of the article or artifactabstract[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 in the author list or contributor listentry[0..*]Used to record a display of the author/contributor list without separate coding 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, represented as a globally unique URI -->
 <identifier><!-- 0..* Identifier Identifier for the Citation resource itself --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the citation -->
 <name value="[string]"/><!-- I 0..1 Name for this citation (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this citation (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher of the Citation Resource --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the citation -->
 <useContext><!-- 0..* UsageContext The context that the Citation Resource content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for citation (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this citation is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact -->
 <approvalDate value="[date]"/><!-- 0..1 When the citation was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the citation was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the citation is expected to be used --></effectivePeriod>
 <author><!-- 0..* ContactDetail Who authored the Citation --></author>
 <editor><!-- 0..* ContactDetail Who edited the Citation --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the Citation --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the Citation --></endorser>
 <summary>  <!-- 0..* A human-readable display of the citation -->
  <style><!-- 0..1 CodeableConcept Format for display of the citation --></style>
  <text value="[markdown]"/><!-- 1..1 The human-readable display of the citation -->
 </summary>
 <classification>  <!-- 0..* The assignment to an organizing scheme -->
  <type><!-- 0..1 CodeableConcept The kind of classifier (e.g. publication type, keyword) --></type>
  <classifier><!-- 0..* CodeableConcept The specific classification value --></classifier>
 </classification>
 <note><!-- 0..* Annotation Used for general notes and annotations not coded elsewhere --></note>
 <currentState><!-- 0..* CodeableConcept The status of the citation --></currentState>
 <statusDate>  <!-- 0..* An effective date or period for a status of the citation -->
  <activity><!-- 1..1 CodeableConcept Classification of the status --></activity>
  <actual value="[boolean]"/><!-- 0..1 Either occurred or expected -->
  <period><!-- 1..1 Period When the status started and/or ended --></period>
 </statusDate>
 <relatedArtifact><!-- 0..* RelatedArtifact Artifact related to the Citation Resource --></relatedArtifact>
 <citedArtifact>  <!-- 0..1 The article or artifact being described -->
  <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier>
  <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier>
  <dateAccessed value="[dateTime]"/><!-- 0..1 When the cited artifact was accessed -->
  <version>  <!-- 0..1 The defined version of the cited artifact -->
   <value value="[string]"/><!-- 1..1 The version number or other version identifier -->
   <baseCitation><!-- 0..1 Reference(Citation) Citation for the main version of the cited artifact --></baseCitation>
  </version>
  <currentState><!-- 0..* CodeableConcept The status of the cited artifact --></currentState>
  <statusDate>  <!-- 0..* An effective date or period for a status of the cited artifact -->
   <activity><!-- 1..1 CodeableConcept Classification of the status --></activity>
   <actual value="[boolean]"/><!-- 0..1 Either occurred or expected -->
   <period><!-- 1..1 Period When the status started and/or ended --></period>
  </statusDate>
  <title>  <!-- 0..* The title details of the article or artifact -->
   <type><!-- 0..* CodeableConcept The kind of title --></type>
   <language><!-- 0..1 CodeableConcept Used to express the specific language --></language>
   <text value="[markdown]"/><!-- 1..1 The title of the article or artifact -->
  </title>
  <abstract>  <!-- 0..* Summary of the article or artifact -->
   <type><!-- 0..1 CodeableConcept The kind of abstract --></type>
   <language><!-- 0..1 CodeableConcept Used to express the specific language --></language>
   <text value="[markdown]"/><!-- 1..1 Abstract content -->
   <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the abstract -->
  </abstract>
  <part>  <!-- 0..1 The component of the article or artifact -->
   <type><!-- 0..1 CodeableConcept The kind of component --></type>
   <value value="[string]"/><!-- 0..1 The specification of the component -->
   <baseCitation><!-- 0..1 Reference(Citation) The citation for the full article or artifact --></baseCitation>
  </part>
  <relatesTo>  <!-- 0..* The artifact related to the cited artifact -->
   <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of -->
   <classifier><!-- 0..* CodeableConcept Additional classifiers --></classifier>
   <label value="[string]"/><!-- 0..1 Short label -->
   <display value="[string]"/><!-- 0..1 Brief description of the related artifact -->
   <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact -->
   <document><!-- 0..1 Attachment What document is being referenced --></document>
   <resource value="[canonical]"/><!-- 0..1 What artifact is being referenced -->
   <resourceReference><!-- 0..1 Reference What artifact, if not a conformance resource --></resourceReference>
  </relatesTo>
  <publicationForm>  <!-- 0..* If multiple, used to represent alternative forms of the article that are not separate citations -->
   <publishedIn>  <!-- 0..1 The collection the cited article or artifact is published in -->
    <type><!-- 0..1 CodeableConcept Kind of container (e.g. Periodical, database, or book) --></type>
    <identifier><!-- 0..* Identifier Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN --></identifier>
    <title value="[string]"/><!-- 0..1 Name of the database or title of the book or journal -->
    <publisher><!-- 0..1 Reference(Organization) Name of the publisher --></publisher>
    <publisherLocation value="[string]"/><!-- 0..1 Geographic location of the publisher -->
   </publishedIn>
   <citedMedium><!-- 0..1 CodeableConcept Internet or Print --></citedMedium>
   <volume value="[string]"/><!-- 0..1 Volume number of journal in which the article is published -->
   <issue value="[string]"/><!-- 0..1 Issue, part or supplement of journal in which the article is published -->
   <publicationDateYear value="[string]"/><!-- 0..1 Year on which the issue of the journal was published -->
   <publicationDateMonth value="[string]"/><!-- 0..1 Month on which the issue of the journal was published -->
   <publicationDateDay value="[string]"/><!-- 0..1 Day on which the issue of the journal was published -->
   <publicationDateSeason value="[string]"/><!-- 0..1 Season on which the issue of the journal was published -->
   <publicationDateText value="[string]"/><!-- 0..1 Text representation of the date of which the issue of the journal was published -->
   <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released -->
   <lastRevisionDate value="[dateTime]"/><!-- 0..1 The date the article was last revised or updated in the database -->
   <language><!-- 0..* CodeableConcept Language in which this form of the article is published --></language>
   <accessionNumber value="[string]"/><!-- 0..1 Entry number or identifier for inclusion in a database -->
   <pageString value="[string]"/><!-- 0..1 Used for full display of pagination -->
   <firstPage value="[string]"/><!-- 0..1 Used for isolated representation of first page -->
   <lastPage value="[string]"/><!-- 0..1 Used for isolated representation of last page -->
   <pageCount value="[string]"/><!-- 0..1 Number of pages or screens -->
   <copyright value="[markdown]"/><!-- 0..1 Copyright notice for the full article or artifact -->
  </publicationForm>
  <webLocation>  <!-- 0..* Used for any URL for the article or artifact cited -->
   <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 in the list -->
    <contributor><!-- 1..1 Reference(Organization|Practitioner) The identity of the individual entity --></contributor>
    <forenameInitials value="[string]"/><!-- 0..1 Initials for forename -->
    <affiliation><!-- 0..* Reference(Organization|PractitionerRole) Organizational affiliation --></affiliation>
    <contributionType><!-- 0..* CodeableConcept The specific contribution --></contributionType>
    <role><!-- 0..1 CodeableConcept The role of the contributor (e.g. author, editor, reviewer) --></role>
    <contributionInstance>  <!-- 0..* Contributions with accounting for time or number -->
     <type><!-- 1..1 CodeableConcept The specific contribution --></type>
     <time value="[dateTime]"/><!-- 0..1 The time that the contribution was made -->
    </contributionInstance>
    <correspondingContact value="[boolean]"/><!-- 0..1 Indication of which contributor is the corresponding contributor for the role -->
    <rankingOrder value="[positiveInt]"/><!-- 0..1 Ranked order of contribution -->
   </entry>
   <summary>  <!-- 0..* Used to record a display of the author/contributor list without separate coding for each list member -->
    <type><!-- 0..1 CodeableConcept Either authorList or contributorshipStatement --></type>
    <style><!-- 0..1 CodeableConcept The format for the display string --></style>
    <source><!-- 0..1 CodeableConcept Used to code the producer or rule for creating the display string --></source>
    <value value="[markdown]"/><!-- 1..1 The display string for the author list, contributor list, or contributorship statement -->
   </summary>
  </contributorship>
  <note><!-- 0..* Annotation Any additional information or content for the article or artifact --></note>
 </citedArtifact>
</Citation>

JSON Template

{doco
  "resourceType" : "Citation",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this citation, represented as a globally unique URI
  "identifier" : [{ Identifier }], // Identifier for the Citation resource itself
  "version" : "<string>", // Business version of the citation
  "name" : "<string>", // I Name for this citation (computer friendly)
  "title" : "<string>", // Name for this citation (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // The publisher of the Citation, not the publisher of the article or artifact being cited
  "contact" : [{ ContactDetail }], // Contact details for the publisher of the Citation Resource
  "description" : "<markdown>", // Natural language description of the citation
  "useContext" : [{ UsageContext }], // The context that the Citation Resource content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation (if applicable)
  "purpose" : "<markdown>", // Why this citation is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions for the Citation, not for the cited artifact
  "approvalDate" : "<date>", // When the citation was approved by publisher
  "lastReviewDate" : "<date>", // When the citation was last reviewed
  "effectivePeriod" : { Period }, // When the citation is expected to be used
  "author" : [{ ContactDetail }], // Who authored the Citation
  "editor" : [{ ContactDetail }], // Who edited the Citation
  "reviewer" : [{ ContactDetail }], // Who reviewed the Citation
  "endorser" : [{ ContactDetail }], // Who endorsed the Citation
  "summary" : [{ // A human-readable display of the citation
    "style" : { CodeableConcept }, // Format for display of the citation
    "text" : "<markdown>" // R!  The human-readable display of the citation
  }],
  "classification" : [{ // The assignment to an organizing scheme
    "type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
    "classifier" : [{ CodeableConcept }] // The specific classification value
  }],
  "note" : [{ Annotation }], // Used for general notes and annotations not coded elsewhere
  "currentState" : [{ CodeableConcept }], // The status of the citation
  "statusDate" : [{ // An effective date or period for a status of the citation
    "activity" : { CodeableConcept }, // R!  Classification of the status
    "actual" : <boolean>, // Either occurred or expected
    "period" : { Period } // R!  When the status started and/or ended
  }],
  "relatedArtifact" : [{ RelatedArtifact }], // Artifact related to the Citation Resource
  "citedArtifact" : { // The article or artifact being described
    "identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc.
    "relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers
    "dateAccessed" : "<dateTime>", // When the cited artifact was accessed
    "version" : { // The defined version of the cited artifact
      "value" : "<string>", // R!  The version number or other version identifier
      "baseCitation" : { Reference(Citation) } // Citation for the main version of the cited artifact
    },
    "currentState" : [{ CodeableConcept }], // The status of the cited artifact
    "statusDate" : [{ // An effective date or period for a status of the cited artifact
      "activity" : { CodeableConcept }, // R!  Classification of the status
      "actual" : <boolean>, // Either occurred or expected
      "period" : { Period } // R!  When the status started and/or ended
    }],
    "title" : [{ // The title details of the article or artifact
      "type" : [{ CodeableConcept }], // The kind of title
      "language" : { CodeableConcept }, // Used to express the specific language
      "text" : "<markdown>" // R!  The title of the article or artifact
    }],
    "abstract" : [{ // Summary of the article or artifact
      "type" : { CodeableConcept }, // The kind of abstract
      "language" : { CodeableConcept }, // Used to express the specific language
      "text" : "<markdown>", // R!  Abstract content
      "copyright" : "<markdown>" // Copyright notice for the abstract
    }],
    "part" : { // The component of the article or artifact
      "type" : { CodeableConcept }, // The kind of component
      "value" : "<string>", // The specification of the component
      "baseCitation" : { Reference(Citation) } // The citation for the full article or artifact
    },
    "relatesTo" : [{ // The artifact related to the cited artifact
      "type" : "<code>", // R!  documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
      "classifier" : [{ CodeableConcept }], // Additional classifiers
      "label" : "<string>", // Short label
      "display" : "<string>", // Brief description of the related artifact
      "citation" : "<markdown>", // Bibliographic citation for the artifact
      "document" : { Attachment }, // What document is being referenced
      "resource" : "<canonical>", // What artifact is being referenced
      "resourceReference" : { Reference } // What artifact, if not a conformance resource
    }],
    "publicationForm" : [{ // If multiple, used to represent alternative forms of the article that are not separate citations
      "publishedIn" : { // The collection the cited article or artifact is published in
        "type" : { CodeableConcept }, // Kind of container (e.g. Periodical, database, or book)
        "identifier" : [{ Identifier }], // Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
        "title" : "<string>", // Name of the database or title of the book or journal
        "publisher" : { Reference(Organization) }, // Name of the publisher
        "publisherLocation" : "<string>" // Geographic location of the publisher
      },
      "citedMedium" : { CodeableConcept }, // Internet or Print
      "volume" : "<string>", // Volume number of journal in which the article is published
      "issue" : "<string>", // Issue, part or supplement of journal in which the article is published
      "publicationDateYear" : "<string>", // Year on which the issue of the journal was published
      "publicationDateMonth" : "<string>", // Month on which the issue of the journal was published
      "publicationDateDay" : "<string>", // Day on which the issue of the journal was published
      "publicationDateSeason" : "<string>", // Season on which the issue of the journal was published
      "publicationDateText" : "<string>", // Text representation of the date of which the issue of the journal was published
      "articleDate" : "<dateTime>", // The date the article was added to the database, or the date the article was released
      "lastRevisionDate" : "<dateTime>", // The date the article was last revised or updated in the database
      "language" : [{ CodeableConcept }], // Language in which this form of the article is published
      "accessionNumber" : "<string>", // Entry number or identifier for inclusion in a database
      "pageString" : "<string>", // Used for full display of pagination
      "firstPage" : "<string>", // Used for isolated representation of first page
      "lastPage" : "<string>", // Used for isolated representation of last page
      "pageCount" : "<string>", // Number of pages or screens
      "copyright" : "<markdown>" // Copyright notice for the full article or artifact
    }],
    "webLocation" : [{ // Used for any URL for the article or artifact cited
      "classifier" : [{ CodeableConcept }], // Code the reason for different URLs, e.g. abstract and full-text
      "url" : "<uri>" // The specific URL
    }],
    "classification" : [{ // The assignment to an organizing scheme
      "type" : { CodeableConcept }, // The kind of classifier (e.g. publication type, keyword)
      "classifier" : [{ CodeableConcept }], // The specific classification value
      "artifactAssessment" : [{ Reference(ArtifactAssessment) }] // Complex or externally created classification

    }],
    "contributorship" : { // Attribution of authors and other contributors
      "complete" : <boolean>, // Indicates if the list includes all authors and/or contributors
      "entry" : [{ // An individual entity named in the list
        "contributor" : { Reference(Organization|Practitioner) }, // R!  The identity of the individual entity
        "forenameInitials" : "<string>", // Initials for forename
        "affiliation" : [{ Reference(Organization|PractitionerRole) }], // Organizational affiliation
        "contributionType" : [{ CodeableConcept }], // The specific contribution
        "role" : { CodeableConcept }, // The role of the contributor (e.g. author, editor, reviewer)
        "contributionInstance" : [{ // Contributions with accounting for time or number
          "type" : { CodeableConcept }, // R!  The specific contribution
          "time" : "<dateTime>" // The time that the contribution was made
        }],
        "correspondingContact" : <boolean>, // Indication of which contributor is the corresponding contributor for the role
        "rankingOrder" : "<positiveInt>" // Ranked order of contribution
      }],
      "summary" : [{ // Used to record a display of the author/contributor list without separate coding for each list member
        "type" : { CodeableConcept }, // Either authorList or contributorshipStatement
        "style" : { CodeableConcept }, // The format for the display string
        "source" : { CodeableConcept }, // Used to code the producer or rule for creating the display string
        "value" : "<markdown>" // R!  The display string for the author list, contributor list, or contributorship statement
      }]
    },
    "note" : [{ Annotation }] // Any additional information or content for the article or artifact
  }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .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:Citation.url [ uri ]; # 0..1 Canonical identifier for this citation, represented as a globally unique URI
  fhir:Citation.identifier [ Identifier ], ... ; # 0..* Identifier for the Citation resource itself
  fhir:Citation.version [ string ]; # 0..1 Business version of the citation
  fhir:Citation.name [ string ]; # 0..1 I Name for this citation (computer friendly)
  fhir:Citation.title [ string ]; # 0..1 Name for this citation (human friendly)
  fhir:Citation.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:Citation.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:Citation.date [ dateTime ]; # 0..1 Date last changed
  fhir:Citation.publisher [ string ]; # 0..1 The publisher of the Citation, not the publisher of the article or artifact being cited
  fhir:Citation.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher of the Citation Resource
  fhir:Citation.description [ markdown ]; # 0..1 Natural language description of the citation
  fhir:Citation.useContext [ UsageContext ], ... ; # 0..* The context that the Citation Resource content is intended to support
  fhir:Citation.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for citation (if applicable)
  fhir:Citation.purpose [ markdown ]; # 0..1 Why this citation is defined
  fhir:Citation.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions for the Citation, not for the cited artifact
  fhir:Citation.approvalDate [ date ]; # 0..1 When the citation was approved by publisher
  fhir:Citation.lastReviewDate [ date ]; # 0..1 When the citation was last reviewed
  fhir:Citation.effectivePeriod [ Period ]; # 0..1 When the citation is expected to be used
  fhir:Citation.author [ ContactDetail ], ... ; # 0..* Who authored the Citation
  fhir:Citation.editor [ ContactDetail ], ... ; # 0..* Who edited the Citation
  fhir:Citation.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the Citation
  fhir:Citation.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the Citation
  fhir:Citation.summary [ # 0..* A human-readable display of the citation
    fhir:Citation.summary.style [ CodeableConcept ]; # 0..1 Format for display of the citation
    fhir:Citation.summary.text [ markdown ]; # 1..1 The human-readable display of the citation
  ], ...;
  fhir:Citation.classification [ # 0..* The assignment to an organizing scheme
    fhir:Citation.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword)
    fhir:Citation.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification value
  ], ...;
  fhir:Citation.note [ Annotation ], ... ; # 0..* Used for general notes and annotations not coded elsewhere
  fhir:Citation.currentState [ CodeableConcept ], ... ; # 0..* The status of the citation
  fhir:Citation.statusDate [ # 0..* An effective date or period for a status of the citation
    fhir:Citation.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status
    fhir:Citation.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected
    fhir:Citation.statusDate.period [ Period ]; # 1..1 When the status started and/or ended
  ], ...;
  fhir:Citation.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Artifact related to the Citation Resource
  fhir:Citation.citedArtifact [ # 0..1 The article or artifact being described
    fhir:Citation.citedArtifact.identifier [ Identifier ], ... ; # 0..* May include DOI, PMID, PMCID, etc.
    fhir:Citation.citedArtifact.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers
    fhir:Citation.citedArtifact.dateAccessed [ dateTime ]; # 0..1 When the cited artifact was accessed
    fhir:Citation.citedArtifact.version [ # 0..1 The defined version of the cited artifact
      fhir:Citation.citedArtifact.version.value [ string ]; # 1..1 The version number or other version identifier
      fhir:Citation.citedArtifact.version.baseCitation [ Reference(Citation) ]; # 0..1 Citation for the main version of the cited artifact
    ];
    fhir:Citation.citedArtifact.currentState [ CodeableConcept ], ... ; # 0..* The status of the cited artifact
    fhir:Citation.citedArtifact.statusDate [ # 0..* An effective date or period for a status of the cited artifact
      fhir:Citation.citedArtifact.statusDate.activity [ CodeableConcept ]; # 1..1 Classification of the status
      fhir:Citation.citedArtifact.statusDate.actual [ boolean ]; # 0..1 Either occurred or expected
      fhir:Citation.citedArtifact.statusDate.period [ Period ]; # 1..1 When the status started and/or ended
    ], ...;
    fhir:Citation.citedArtifact.title [ # 0..* The title details of the article or artifact
      fhir:Citation.citedArtifact.title.type [ CodeableConcept ], ... ; # 0..* The kind of title
      fhir:Citation.citedArtifact.title.language [ CodeableConcept ]; # 0..1 Used to express the specific language
      fhir:Citation.citedArtifact.title.text [ markdown ]; # 1..1 The title of the article or artifact
    ], ...;
    fhir:Citation.citedArtifact.abstract [ # 0..* Summary of the article or artifact
      fhir:Citation.citedArtifact.abstract.type [ CodeableConcept ]; # 0..1 The kind of abstract
      fhir:Citation.citedArtifact.abstract.language [ CodeableConcept ]; # 0..1 Used to express the specific language
      fhir:Citation.citedArtifact.abstract.text [ markdown ]; # 1..1 Abstract content
      fhir:Citation.citedArtifact.abstract.copyright [ markdown ]; # 0..1 Copyright notice for the abstract
    ], ...;
    fhir:Citation.citedArtifact.part [ # 0..1 The component of the article or artifact
      fhir:Citation.citedArtifact.part.type [ CodeableConcept ]; # 0..1 The kind of component
      fhir:Citation.citedArtifact.part.value [ string ]; # 0..1 The specification of the component
      fhir:Citation.citedArtifact.part.baseCitation [ Reference(Citation) ]; # 0..1 The citation for the full article or artifact
    ];
    fhir:Citation.citedArtifact.relatesTo [ # 0..* The artifact related to the cited artifact
      fhir:Citation.citedArtifact.relatesTo.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of
      fhir:Citation.citedArtifact.relatesTo.classifier [ CodeableConcept ], ... ; # 0..* Additional classifiers
      fhir:Citation.citedArtifact.relatesTo.label [ string ]; # 0..1 Short label
      fhir:Citation.citedArtifact.relatesTo.display [ string ]; # 0..1 Brief description of the related artifact
      fhir:Citation.citedArtifact.relatesTo.citation [ markdown ]; # 0..1 Bibliographic citation for the artifact
      fhir:Citation.citedArtifact.relatesTo.document [ Attachment ]; # 0..1 What document is being referenced
      fhir:Citation.citedArtifact.relatesTo.resource [ canonical ]; # 0..1 What artifact is being referenced
      fhir:Citation.citedArtifact.relatesTo.resourceReference [ Reference ]; # 0..1 What artifact, if not a conformance resource
    ], ...;
    fhir:Citation.citedArtifact.publicationForm [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations
      fhir:Citation.citedArtifact.publicationForm.publishedIn [ # 0..1 The collection the cited article or artifact is published in
        fhir:Citation.citedArtifact.publicationForm.publishedIn.type [ CodeableConcept ]; # 0..1 Kind of container (e.g. Periodical, database, or book)
        fhir:Citation.citedArtifact.publicationForm.publishedIn.identifier [ Identifier ], ... ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN
        fhir:Citation.citedArtifact.publicationForm.publishedIn.title [ string ]; # 0..1 Name of the database or title of the book or journal
        fhir:Citation.citedArtifact.publicationForm.publishedIn.publisher [ Reference(Organization) ]; # 0..1 Name of the publisher
        fhir:Citation.citedArtifact.publicationForm.publishedIn.publisherLocation [ string ]; # 0..1 Geographic location of the publisher
      ];
      fhir:Citation.citedArtifact.publicationForm.citedMedium [ CodeableConcept ]; # 0..1 Internet or Print
      fhir:Citation.citedArtifact.publicationForm.volume [ string ]; # 0..1 Volume number of journal in which the article is published
      fhir:Citation.citedArtifact.publicationForm.issue [ string ]; # 0..1 Issue, part or supplement of journal in which the article is published
      fhir:Citation.citedArtifact.publicationForm.publicationDateYear [ string ]; # 0..1 Year on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateMonth [ string ]; # 0..1 Month on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateDay [ string ]; # 0..1 Day on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateSeason [ string ]; # 0..1 Season on which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.publicationDateText [ string ]; # 0..1 Text representation of the date of which the issue of the journal was published
      fhir:Citation.citedArtifact.publicationForm.articleDate [ dateTime ]; # 0..1 The date the article was added to the database, or the date the article was released
      fhir:Citation.citedArtifact.publicationForm.lastRevisionDate [ dateTime ]; # 0..1 The date the article was last revised or updated in the database
      fhir:Citation.citedArtifact.publicationForm.language [ CodeableConcept ], ... ; # 0..* Language in which this form of the article is published
      fhir:Citation.citedArtifact.publicationForm.accessionNumber [ string ]; # 0..1 Entry number or identifier for inclusion in a database
      fhir:Citation.citedArtifact.publicationForm.pageString [ string ]; # 0..1 Used for full display of pagination
      fhir:Citation.citedArtifact.publicationForm.firstPage [ string ]; # 0..1 Used for isolated representation of first page
      fhir:Citation.citedArtifact.publicationForm.lastPage [ string ]; # 0..1 Used for isolated representation of last page
      fhir:Citation.citedArtifact.publicationForm.pageCount [ string ]; # 0..1 Number of pages or screens
      fhir:Citation.citedArtifact.publicationForm.copyright [ markdown ]; # 0..1 Copyright notice for the full article or artifact
    ], ...;
    fhir:Citation.citedArtifact.webLocation [ # 0..* Used for any URL for the article or artifact cited
      fhir:Citation.citedArtifact.webLocation.classifier [ CodeableConcept ], ... ; # 0..* Code the reason for different URLs, e.g. abstract and full-text
      fhir:Citation.citedArtifact.webLocation.url [ uri ]; # 0..1 The specific URL
    ], ...;
    fhir:Citation.citedArtifact.classification [ # 0..* The assignment to an organizing scheme
      fhir:Citation.citedArtifact.classification.type [ CodeableConcept ]; # 0..1 The kind of classifier (e.g. publication type, keyword)
      fhir:Citation.citedArtifact.classification.classifier [ CodeableConcept ], ... ; # 0..* The specific classification value
      fhir:Citation.citedArtifact.classification.artifactAssessment [ Reference(ArtifactAssessment) ], ... ; # 0..* Complex or externally created classification

    ], ...;
    fhir:Citation.citedArtifact.contributorship [ # 0..1 Attribution of authors and other contributors
      fhir:Citation.citedArtifact.contributorship.complete [ boolean ]; # 0..1 Indicates if the list includes all authors and/or contributors
      fhir:Citation.citedArtifact.contributorship.entry [ # 0..* An individual entity named in the list
        fhir:Citation.citedArtifact.contributorship.entry.contributor [ Reference(Organization|Practitioner) ]; # 1..1 The identity of the individual entity
        fhir:Citation.citedArtifact.contributorship.entry.forenameInitials [ string ]; # 0..1 Initials for forename
        fhir:Citation.citedArtifact.contributorship.entry.affiliation [ Reference(Organization|PractitionerRole) ], ... ; # 0..* Organizational affiliation
        fhir:Citation.citedArtifact.contributorship.entry.contributionType [ CodeableConcept ], ... ; # 0..* The specific contribution
        fhir:Citation.citedArtifact.contributorship.entry.role [ CodeableConcept ]; # 0..1 The role of the contributor (e.g. author, editor, reviewer)
        fhir:Citation.citedArtifact.contributorship.entry.contributionInstance [ # 0..* Contributions with accounting for time or number
          fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.type [ CodeableConcept ]; # 1..1 The specific contribution
          fhir:Citation.citedArtifact.contributorship.entry.contributionInstance.time [ dateTime ]; # 0..1 The time that the contribution was made
        ], ...;
        fhir:Citation.citedArtifact.contributorship.entry.correspondingContact [ boolean ]; # 0..1 Indication of which contributor is the corresponding contributor for the role
        fhir:Citation.citedArtifact.contributorship.entry.rankingOrder [ positiveInt ]; # 0..1 Ranked order of contribution
      ], ...;
      fhir:Citation.citedArtifact.contributorship.summary [ # 0..* Used to record a display of the author/contributor list without separate coding for each list member
        fhir:Citation.citedArtifact.contributorship.summary.type [ CodeableConcept ]; # 0..1 Either authorList or contributorshipStatement
        fhir:Citation.citedArtifact.contributorship.summary.style [ CodeableConcept ]; # 0..1 The format for the display string
        fhir:Citation.citedArtifact.contributorship.summary.source [ CodeableConcept ]; # 0..1 Used to code the producer or rule for creating the display string
        fhir:Citation.citedArtifact.contributorship.summary.value [ markdown ]; # 1..1 The display string for the author list, contributor list, or contributorship statement
      ], ...;
    ];
    fhir:Citation.citedArtifact.note [ Annotation ], ... ; # 0..* Any additional information or content for the article or artifact
  ];
]

Changes since Release 4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

 

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

PathDefinitionTypeReference
Citation.status

The lifecycle status of an artifact.

RequiredPublicationStatus
Citation.jurisdiction

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

ExtensibleJurisdictionValueSet
Citation.summary.style

The format for display of the citation.

ExtensibleCitationSummaryStyle
Citation.classification.type

Citation classification type

ExtensibleCitationClassificationType
Citation.classification.classifier

Citation artifact classifier

ExampleCitationArtifactClassifier
Citation.currentState

Citation status type

ExampleCitationStatusType
Citation.statusDate.activity

Citation status type

ExampleCitationStatusType
Citation.citedArtifact.currentState

Cited Artifact Status Type

ExtensibleCitedArtifactStatusType
Citation.citedArtifact.statusDate.activity

Cited Artifact Status Type

ExtensibleCitedArtifactStatusType
Citation.citedArtifact.title.type

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

ExtensibleTitleType
Citation.citedArtifact.title.language

This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47)

PreferredCommonLanguages
Citation.citedArtifact.abstract.type

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

ExtensibleCitedArtifactAbstractType
Citation.citedArtifact.abstract.language

This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47)

PreferredCommonLanguages
Citation.citedArtifact.part.type

To describe the reason for the variant citation, such as version number or subpart specification.

ExtensibleCitedArtifactPartType
Citation.citedArtifact.relatesTo.type

The type of relationship to the cited artifact.

RequiredRelatedArtifactTypeExpanded
Citation.citedArtifact.relatesTo.classifier

Citation artifact classifier

ExtensibleCitationArtifactClassifier
Citation.citedArtifact.publicationForm.publishedIn.type

The type of publication such as book, database, or journal.

ExtensiblePublishedInType
Citation.citedArtifact.publicationForm.citedMedium

NLM codes Internet or Print.

ExtensibleCitedMedium
Citation.citedArtifact.publicationForm.language

This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47)

PreferredCommonLanguages
Citation.citedArtifact.webLocation.classifier

Code the reason for different URLs, eg abstract and full-text.

ExtensibleArtifactUrlClassifier
Citation.citedArtifact.classification.type

Cited Artifact Classification Type

ExtensibleCitedArtifactClassificationType
Citation.citedArtifact.classification.classifier

Citation artifact classifier

ExampleCitationArtifactClassifier
Citation.citedArtifact.contributorship.entry.contributionType

Citation contribution.

ExtensibleArtifactContributionType
Citation.citedArtifact.contributorship.entry.role

Used to code the format of the display string.

ExtensibleContributorRole
Citation.citedArtifact.contributorship.entry.contributionInstance.type

Artifact Contribution Instance Type

ExtensibleArtifactContributionInstanceType
Citation.citedArtifact.contributorship.summary.type

Used to code author list statement, contributorship statement, and such.

ExtensibleContributorSummaryType
Citation.citedArtifact.contributorship.summary.style

Used to code the format of the display string.

ExtensibleContributorSummaryStyle
Citation.citedArtifact.contributorship.summary.source

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

ExtensibleContributorSummarySource

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 problematicurl.matches('([^|#])*')

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the citation(Citation.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the citation(Citation.useContext.value as Quantity) | (Citation.useContext.value as Range)
context-typetokenA type of use context assigned to the citationCitation.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the citationOn Citation.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)
context-type-valuecompositeA use context type and value assigned to the citationOn Citation.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)
date NdateThe citation publication dateCitation.date
description NstringThe description of the citationCitation.description
effectivedateThe time during which the citation is intended to be in useCitation.effectivePeriod
identifiertokenExternal identifier for the citationCitation.identifier
jurisdictiontokenIntended jurisdiction for the citationCitation.jurisdiction
name NstringComputationally friendly name of the citationCitation.name
publisher NstringName of the publisher of the citationCitation.publisher
status NtokenThe current status of the citationCitation.status
title NstringThe human-friendly name of the citationCitation.title
url NuriThe uri that identifies the citationCitation.url
version NtokenThe business version of the citationCitation.version