This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
The Citation Resource enables reference to any knowledge artifact for purposes of identification and attribution. The Citation Resource supports existing reference structures and developing publication practices such as versioning, expressing complex contributorship roles, and referencing computable resources.
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 provides human-readable information.
Even the canonical article today is complex. The variantCitation accommodates versions, sets of articles, and multi-part articles including Supplements
Published articles usually have a title, called here articleTitle, although the articleTitle element can be used for the name of the book chapter or database entry when such articles are cited. All citations that are findable on the internet can have a webLocation.
Attribution is expressed as contributorship, which has grown more complicated as the very nature of authorship has become complicated, and as the concerns for credit and acknowledgement are increasingly complex. If a complex individualized attribution structure is not required, the contributorship.summary will do.
“Publication” must now cover books, books series, article series, database registries, database updates, and the like. The element, publicationForm, enables this complex description. Within 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 article being cited.
Many elements, including classifier and keywordList may include the system or source behind codable concepts. Nevertheless, the National Library of Medicine (NLM) has played such an important role in curating references to the world’s biomedical literature, a medline element is included for backwards compatibility and to contain multiple elements for which NLM systems are the only relevant systems, thus reducing the need to code the system for data exchange.
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.
This resource is referenced by itself, Evidence and EvidenceReport.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Citation | TU | DomainResource | A citation of a publication + 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 | |
url | Σ | 0..1 | uri | Canonical identifier for this citation, represented as a globally unique URI |
identifier | Σ | 0..* | Identifier | May include DOI, PMID, PMCID, etc. |
relatedIdentifier | Σ | 0..* | Identifier | May include trial registry identifiers |
version | Σ | 0..1 | string | Business version of the citation |
name | ΣI | 0..1 | string | Name for this citation (computer friendly) |
title | Σ | 0..1 | string | Name for this citation (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | The publisher of the Citation, not the publisher of the article being cited |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the citation | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for citation (if applicable) Jurisdiction (Extensible) |
purpose | 0..1 | markdown | Why this citation is defined | |
approvalDate | 0..1 | date | When the citation was approved by publisher | |
lastReviewDate | 0..1 | date | When the citation was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the citation is expected to be used |
summary | 0..* | BackboneElement | A human-readable display of the citation | |
style | 0..1 | CodeableConcept | Format for display of the citation CitationSummaryStyle (Extensible) | |
text | Σ | 1..1 | markdown | The human-readable display of the citation |
dateCited | Σ | 0..1 | dateTime | When the citation was cited |
variantCitation | 0..1 | BackboneElement | An alternative variant of the citation | |
type | 0..1 | CodeableConcept | Used to describe the reason for the variant citation, such as version or subpart specification CitationVariantType (Extensible) | |
value | 0..1 | string | Used to describe the specific variation, such as version number or subpart specification | |
baseCitation | 0..1 | Reference(Citation) | Base citation layer | |
articleTitle | 0..* | BackboneElement | The name of the article | |
type | 0..1 | CodeableConcept | Used to express the reason and specific aspect for any variant title, such as language AlternativeTitleType (Extensible) | |
language | 0..1 | CodeableConcept | Used to express the specific language Common Languages (Preferred but limited to AllLanguages) | |
text | 1..1 | markdown | Full title of the article | |
webLocation | 0..* | BackboneElement | Used for any URL for the article cited | |
type | 0..1 | CodeableConcept | Code the reason for different URLs, e.g. abstract and full-text ArticleUrlType (Extensible) | |
url | 0..1 | uri | The specific URL | |
abstract | 0..* | BackboneElement | Publisher-provided summary of the article | |
type | 0..1 | CodeableConcept | Used to express the reason for an additional or variant abstract, such as language AlternativeTitleType (Extensible) | |
language | 0..1 | CodeableConcept | Used to express the specific language Common Languages (Preferred but limited to AllLanguages) | |
text | 1..1 | markdown | Abstract content | |
copyright | 0..1 | markdown | Copyright notice for the abstract | |
contributorship | 0..1 | BackboneElement | Attribution of authors and other contributors | |
complete | 0..1 | boolean | Indicates if the list includes all authors and/or contributors | |
entry | 0..* | BackboneElement | An individual entity named in the list | |
name | 0..1 | HumanName | A name associated with the person | |
initials | 0..1 | string | Initials for forename | |
collectiveName | 0..1 | string | Used for collective or corporate name as an author | |
identifier | 0..* | Identifier | Author identifier, eg ORCID | |
affiliationInfo | 0..* | BackboneElement | Organizational affiliation | |
affiliation | 0..1 | string | Display for the organization | |
role | 0..1 | string | Role within the organization, such as professional title | |
identifier | 0..* | Identifier | Identifier for the organization | |
address | 0..* | Address | Physical mailing address | |
telecom | 0..* | ContactPoint | Email or telephone contact methods for | |
contribution | 0..* | CodeableConcept | The specific contributions CitationContribution (Extensible) | |
notAnAuthor | 0..1 | boolean | Used to identify non-author contributors | |
correspondingAuthor | 0..1 | boolean | Indication of which author is the corresponding author for the article cited | |
listOrder | 0..1 | positiveInt | Used to code order of authors | |
summary | 0..* | BackboneElement | Used to record a display of the author/contributor list without separate coding for each list member | |
type | 0..1 | CodeableConcept | Either authorList or contributorshipStatement ContributorSummaryType (Extensible) | |
style | 0..1 | CodeableConcept | The format for the display string ContributorSummaryStyle (Extensible) | |
source | 0..1 | CodeableConcept | Used to code the producer or rule for creating the display string ContributorSummarySource (Extensible) | |
value | 1..1 | markdown | The display string for the author list, contributor list, or contributorship statement | |
publicationForm | 0..* | BackboneElement | If multiple, used to represent alternative forms of the article that are not separate citations | |
publishingModel | 0..1 | CodeableConcept | Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic PublishingModelType (Extensible) | |
publishedIn | 0..1 | BackboneElement | The collection the cited article is published in | |
type | 0..1 | CodeableConcept | Periodical, database, or book PublishedInType (Extensible) | |
identifier | 0..* | Identifier | Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN | |
title | 0..1 | string | Name of the database or title of the book or journal | |
publisher | 0..1 | Reference(Organization) | Name of the publisher | |
publisherLocation | 0..1 | string | Geographic location of the publisher | |
startDate | 0..1 | date | When the database was first available or when the book was published | |
periodicRelease | 0..* | BackboneElement | The specific issue in which the cited article resides | |
citedMedium | 0..1 | CodeableConcept | Internet or Print JournalIssueMedium (Extensible) | |
volume | 0..1 | string | Volume number of journal in which the article is published | |
issue | 0..1 | string | Issue, part or supplement of journal in which the article is published | |
dateOfPublication | 0..1 | BackboneElement | Defining the date on which the issue of the journal was published | |
date | 0..1 | date | Date on which the issue of the journal was published | |
year | 0..1 | string | Year on which the issue of the journal was published | |
month | 0..1 | string | Month on which the issue of the journal was published | |
day | 0..1 | string | Day on which the issue of the journal was published | |
season | 0..1 | string | Season on which the issue of the journal was published | |
text | 0..1 | string | Text representation of the date of which the issue of the journal was published | |
articleDate | 0..1 | dateTime | The date the article was added to the database, or the date the article was released | |
revisionDate | 0..1 | dateTime | The date the article was last revised or updated in the database | |
language | 0..* | CodeableConcept | Language in which this form of the article is published Common Languages (Preferred but limited to AllLanguages) | |
pageString | 0..1 | string | Used for full display of pagination | |
firstPage | 0..1 | string | Used for isolated representation of first page | |
lastPage | 0..1 | string | Used for isolated representation of last page | |
pageCount | 0..1 | string | Number of pages or screens | |
classifier | 0..* | CodeableConcept | Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical CitationClassifier (Extensible) | |
keywordList | 0..* | BackboneElement | Used to support keyword searches | |
owner | 0..1 | string | Author, publisher, or custodian of the keyword list | |
keyword | 1..* | BackboneElement | For each keyword in the keyword list | |
majorTopic | 0..1 | boolean | Whether or not it is a major topic | |
value | 1..1 | string | The actual keyword | |
relatedArtifact | 0..* | RelatedArtifact | Link or citation to artifact associated with the referenced material | |
note | 0..* | Annotation | Used for general notes and annotations not coded elsewhere | |
medline | 0..1 | BackboneElement | These elements are items with values assigned by MEDLINE or PubMed management | |
state | 0..1 | code | Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE MedlineCitationStatus (Required) | |
owner | 0..1 | code | NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM MedlineCitationOwner (Required) | |
dateCreated | 0..1 | date | Creation date | |
dateCompleted | 0..1 | date | Completion date | |
dateRevised | 0..1 | date | Revision date | |
dateOnPubMed | 0..* | BackboneElement | Date of PubMed publication | |
publicationState | 0..1 | code | received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release PubMedPubStatus (Required) | |
date | 0..1 | dateTime | PubMed Publication Date | |
publicationState | 0..1 | code | received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release PubMedPubStatus (Required) | |
relatedArticle | 0..* | BackboneElement | Citation details for the related article | |
citationReference | 0..1 | Reference(Citation) | Citation Resource for related article | |
citationMarkdown | 0..1 | markdown | Citation string for related article | |
identifier | 0..* | Identifier | Citation identifier for the related article | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<Citation xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this citation, represented as a globally unique URI --> <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier> <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier> <version value="[string]"/><!-- 0..1 Business version of the citation --> <name value="[string]"/><!-- 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 being cited --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the citation --> <useContext><!-- 0..* UsageContext The context that the 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 --> <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> <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> <dateCited value="[dateTime]"/><!-- 0..1 When the citation was cited --> <variantCitation> <!-- 0..1 An alternative variant of the citation --> <type><!-- 0..1 CodeableConcept Used to describe the reason for the variant citation, such as version or subpart specification --></type> <value value="[string]"/><!-- 0..1 Used to describe the specific variation, such as version number or subpart specification --> <baseCitation><!-- 0..1 Reference(Citation) Base citation layer --></baseCitation> </variantCitation> <articleTitle> <!-- 0..* The name of the article --> <type><!-- 0..1 CodeableConcept Used to express the reason and specific aspect for any variant title, such as language --></type> <language><!-- 0..1 CodeableConcept Used to express the specific language --></language> <text value="[markdown]"/><!-- 1..1 Full title of the article --> </articleTitle> <webLocation> <!-- 0..* Used for any URL for the article cited --> <type><!-- 0..1 CodeableConcept Code the reason for different URLs, e.g. abstract and full-text --></type> <url value="[uri]"/><!-- 0..1 The specific URL --> </webLocation> <abstract> <!-- 0..* Publisher-provided summary of the article --> <type><!-- 0..1 CodeableConcept Used to express the reason for an additional or variant abstract, such as language --></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> <contributorship> <!-- 0..1 Attribution of authors and other contributors --> <complete value="[boolean]"/><!-- 0..1 Indicates if the list includes all authors and/or contributors --> <entry> <!-- 0..* An individual entity named in the list --> <name><!-- 0..1 HumanName A name associated with the person --></name> <initials value="[string]"/><!-- 0..1 Initials for forename --> <collectiveName value="[string]"/><!-- 0..1 Used for collective or corporate name as an author --> <identifier><!-- 0..* Identifier Author identifier, eg ORCID --></identifier> <affiliationInfo> <!-- 0..* Organizational affiliation --> <affiliation value="[string]"/><!-- 0..1 Display for the organization --> <role value="[string]"/><!-- 0..1 Role within the organization, such as professional title --> <identifier><!-- 0..* Identifier Identifier for the organization --></identifier> </affiliationInfo> <address><!-- 0..* Address Physical mailing address --></address> <telecom><!-- 0..* ContactPoint Email or telephone contact methods for --></telecom> <contribution><!-- 0..* CodeableConcept The specific contributions --></contribution> <notAnAuthor value="[boolean]"/><!-- 0..1 Used to identify non-author contributors --> <correspondingAuthor value="[boolean]"/><!-- 0..1 Indication of which author is the corresponding author for the article cited --> <listOrder value="[positiveInt]"/><!-- 0..1 Used to code order of authors --> </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> <publicationForm> <!-- 0..* If multiple, used to represent alternative forms of the article that are not separate citations --> <publishingModel><!-- 0..1 CodeableConcept Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic --></publishingModel> <publishedIn> <!-- 0..1 The collection the cited article is published in --> <type><!-- 0..1 CodeableConcept 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 --> <startDate value="[date]"/><!-- 0..1 When the database was first available or when the book was published --> </publishedIn> <periodicRelease> <!-- 0..* The specific issue in which the cited article resides --> <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 --> <dateOfPublication> <!-- 0..1 Defining the date on which the issue of the journal was published --> <date value="[date]"/><!-- 0..1 Date on which the issue of the journal was published --> <year value="[string]"/><!-- 0..1 Year on which the issue of the journal was published --> <month value="[string]"/><!-- 0..1 Month on which the issue of the journal was published --> <day value="[string]"/><!-- 0..1 Day on which the issue of the journal was published --> <season value="[string]"/><!-- 0..1 Season on which the issue of the journal was published --> <text value="[string]"/><!-- 0..1 Text representation of the date of which the issue of the journal was published --> </dateOfPublication> </periodicRelease> <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released --> <revisionDate 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> <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 --> </publicationForm> <classifier><!-- 0..* CodeableConcept Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical --></classifier> <keywordList> <!-- 0..* Used to support keyword searches --> <owner value="[string]"/><!-- 0..1 Author, publisher, or custodian of the keyword list --> <keyword> <!-- 1..* For each keyword in the keyword list --> <majorTopic value="[boolean]"/><!-- 0..1 Whether or not it is a major topic --> <value value="[string]"/><!-- 1..1 The actual keyword --> </keyword> </keywordList> <relatedArtifact><!-- 0..* RelatedArtifact Link or citation to artifact associated with the referenced material --></relatedArtifact> <note><!-- 0..* Annotation Used for general notes and annotations not coded elsewhere --></note> <medline> <!-- 0..1 These elements are items with values assigned by MEDLINE or PubMed management --> <state value="[code]"/><!-- 0..1 Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE --> <owner value="[code]"/><!-- 0..1 NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM --> <dateCreated value="[date]"/><!-- 0..1 Creation date --> <dateCompleted value="[date]"/><!-- 0..1 Completion date --> <dateRevised value="[date]"/><!-- 0..1 Revision date --> <dateOnPubMed> <!-- 0..* Date of PubMed publication --> <publicationState value="[code]"/><!-- 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release --> <date value="[dateTime]"/><!-- 0..1 PubMed Publication Date --> </dateOnPubMed> <publicationState value="[code]"/><!-- 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release --> <relatedArticle> <!-- 0..* Citation details for the related article --> <citationReference><!-- 0..1 Reference(Citation) Citation Resource for related article --></citationReference> <citationMarkdown value="[markdown]"/><!-- 0..1 Citation string for related article --> <identifier><!-- 0..* Identifier Citation identifier for the related article --></identifier> </relatedArticle> </medline> </Citation>
JSON Template
{ "resourceType" : "Citation", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this citation, represented as a globally unique URI "identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc. "relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers "version" : "<string>", // Business version of the citation "name" : "<string>", // C? 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 being cited "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the citation "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation (if applicable) "purpose" : "<markdown>", // Why this citation is defined "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 "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 }], "dateCited" : "<dateTime>", // When the citation was cited "variantCitation" : { // An alternative variant of the citation "type" : { CodeableConcept }, // Used to describe the reason for the variant citation, such as version or subpart specification "value" : "<string>", // Used to describe the specific variation, such as version number or subpart specification "baseCitation" : { Reference(Citation) } // Base citation layer }, "articleTitle" : [{ // The name of the article "type" : { CodeableConcept }, // Used to express the reason and specific aspect for any variant title, such as language "language" : { CodeableConcept }, // Used to express the specific language "text" : "<markdown>" // R! Full title of the article }], "webLocation" : [{ // Used for any URL for the article cited "type" : { CodeableConcept }, // Code the reason for different URLs, e.g. abstract and full-text "url" : "<uri>" // The specific URL }], "abstract" : [{ // Publisher-provided summary of the article "type" : { CodeableConcept }, // Used to express the reason for an additional or variant abstract, such as language "language" : { CodeableConcept }, // Used to express the specific language "text" : "<markdown>", // R! Abstract content "copyright" : "<markdown>" // Copyright notice for the abstract }], "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 "name" : { HumanName }, // A name associated with the person "initials" : "<string>", // Initials for forename "collectiveName" : "<string>", // Used for collective or corporate name as an author "identifier" : [{ Identifier }], // Author identifier, eg ORCID "affiliationInfo" : [{ // Organizational affiliation "affiliation" : "<string>", // Display for the organization "role" : "<string>", // Role within the organization, such as professional title "identifier" : [{ Identifier }] // Identifier for the organization }], "address" : [{ Address }], // Physical mailing address "telecom" : [{ ContactPoint }], // Email or telephone contact methods for "contribution" : [{ CodeableConcept }], // The specific contributions "notAnAuthor" : <boolean>, // Used to identify non-author contributors "correspondingAuthor" : <boolean>, // Indication of which author is the corresponding author for the article cited "listOrder" : "<positiveInt>" // Used to code order of authors }], "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 }] }, "publicationForm" : [{ // If multiple, used to represent alternative forms of the article that are not separate citations "publishingModel" : { CodeableConcept }, // Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic "publishedIn" : { // The collection the cited article is published in "type" : { CodeableConcept }, // 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 "startDate" : "<date>" // When the database was first available or when the book was published }, "periodicRelease" : [{ // The specific issue in which the cited article resides "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 "dateOfPublication" : { // Defining the date on which the issue of the journal was published "date" : "<date>", // Date on which the issue of the journal was published "year" : "<string>", // Year on which the issue of the journal was published "month" : "<string>", // Month on which the issue of the journal was published "day" : "<string>", // Day on which the issue of the journal was published "season" : "<string>", // Season on which the issue of the journal was published "text" : "<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 "revisionDate" : "<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 "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 }], "classifier" : [{ CodeableConcept }], // Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical "keywordList" : [{ // Used to support keyword searches "owner" : "<string>", // Author, publisher, or custodian of the keyword list "keyword" : [{ // R! For each keyword in the keyword list "majorTopic" : <boolean>, // Whether or not it is a major topic "value" : "<string>" // R! The actual keyword }] }], "relatedArtifact" : [{ RelatedArtifact }], // Link or citation to artifact associated with the referenced material "note" : [{ Annotation }], // Used for general notes and annotations not coded elsewhere "medline" : { // These elements are items with values assigned by MEDLINE or PubMed management "state" : "<code>", // Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE "owner" : "<code>", // NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM "dateCreated" : "<date>", // Creation date "dateCompleted" : "<date>", // Completion date "dateRevised" : "<date>", // Revision date "dateOnPubMed" : [{ // Date of PubMed publication "publicationState" : "<code>", // received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release "date" : "<dateTime>" // PubMed Publication Date }], "publicationState" : "<code>", // received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release "relatedArticle" : [{ // Citation details for the related article "citationReference" : { Reference(Citation) }, // Citation Resource for related article "citationMarkdown" : "<markdown>", // Citation string for related article "identifier" : [{ Identifier }] // Citation identifier for the related article }] } }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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..* May include DOI, PMID, PMCID, etc. fhir:Citation.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers fhir:Citation.version [ string ]; # 0..1 Business version of the citation fhir:Citation.name [ string ]; # 0..1 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 being cited fhir:Citation.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:Citation.description [ markdown ]; # 0..1 Natural language description of the citation fhir:Citation.useContext [ UsageContext ], ... ; # 0..* The context that the 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.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.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.dateCited [ dateTime ]; # 0..1 When the citation was cited fhir:Citation.variantCitation [ # 0..1 An alternative variant of the citation fhir:Citation.variantCitation.type [ CodeableConcept ]; # 0..1 Used to describe the reason for the variant citation, such as version or subpart specification fhir:Citation.variantCitation.value [ string ]; # 0..1 Used to describe the specific variation, such as version number or subpart specification fhir:Citation.variantCitation.baseCitation [ Reference(Citation) ]; # 0..1 Base citation layer ]; fhir:Citation.articleTitle [ # 0..* The name of the article fhir:Citation.articleTitle.type [ CodeableConcept ]; # 0..1 Used to express the reason and specific aspect for any variant title, such as language fhir:Citation.articleTitle.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.articleTitle.text [ markdown ]; # 1..1 Full title of the article ], ...; fhir:Citation.webLocation [ # 0..* Used for any URL for the article cited fhir:Citation.webLocation.type [ CodeableConcept ]; # 0..1 Code the reason for different URLs, e.g. abstract and full-text fhir:Citation.webLocation.url [ uri ]; # 0..1 The specific URL ], ...; fhir:Citation.abstract [ # 0..* Publisher-provided summary of the article fhir:Citation.abstract.type [ CodeableConcept ]; # 0..1 Used to express the reason for an additional or variant abstract, such as language fhir:Citation.abstract.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.abstract.text [ markdown ]; # 1..1 Abstract content fhir:Citation.abstract.copyright [ markdown ]; # 0..1 Copyright notice for the abstract ], ...; fhir:Citation.contributorship [ # 0..1 Attribution of authors and other contributors fhir:Citation.contributorship.complete [ boolean ]; # 0..1 Indicates if the list includes all authors and/or contributors fhir:Citation.contributorship.entry [ # 0..* An individual entity named in the list fhir:Citation.contributorship.entry.name [ HumanName ]; # 0..1 A name associated with the person fhir:Citation.contributorship.entry.initials [ string ]; # 0..1 Initials for forename fhir:Citation.contributorship.entry.collectiveName [ string ]; # 0..1 Used for collective or corporate name as an author fhir:Citation.contributorship.entry.identifier [ Identifier ], ... ; # 0..* Author identifier, eg ORCID fhir:Citation.contributorship.entry.affiliationInfo [ # 0..* Organizational affiliation fhir:Citation.contributorship.entry.affiliationInfo.affiliation [ string ]; # 0..1 Display for the organization fhir:Citation.contributorship.entry.affiliationInfo.role [ string ]; # 0..1 Role within the organization, such as professional title fhir:Citation.contributorship.entry.affiliationInfo.identifier [ Identifier ], ... ; # 0..* Identifier for the organization ], ...; fhir:Citation.contributorship.entry.address [ Address ], ... ; # 0..* Physical mailing address fhir:Citation.contributorship.entry.telecom [ ContactPoint ], ... ; # 0..* Email or telephone contact methods for fhir:Citation.contributorship.entry.contribution [ CodeableConcept ], ... ; # 0..* The specific contributions fhir:Citation.contributorship.entry.notAnAuthor [ boolean ]; # 0..1 Used to identify non-author contributors fhir:Citation.contributorship.entry.correspondingAuthor [ boolean ]; # 0..1 Indication of which author is the corresponding author for the article cited fhir:Citation.contributorship.entry.listOrder [ positiveInt ]; # 0..1 Used to code order of authors ], ...; fhir:Citation.contributorship.summary [ # 0..* Used to record a display of the author/contributor list without separate coding for each list member fhir:Citation.contributorship.summary.type [ CodeableConcept ]; # 0..1 Either authorList or contributorshipStatement fhir:Citation.contributorship.summary.style [ CodeableConcept ]; # 0..1 The format for the display string fhir:Citation.contributorship.summary.source [ CodeableConcept ]; # 0..1 Used to code the producer or rule for creating the display string fhir:Citation.contributorship.summary.value [ markdown ]; # 1..1 The display string for the author list, contributor list, or contributorship statement ], ...; ]; fhir:Citation.publicationForm [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations fhir:Citation.publicationForm.publishingModel [ CodeableConcept ]; # 0..1 Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic fhir:Citation.publicationForm.publishedIn [ # 0..1 The collection the cited article is published in fhir:Citation.publicationForm.publishedIn.type [ CodeableConcept ]; # 0..1 Periodical, database, or book fhir:Citation.publicationForm.publishedIn.identifier [ Identifier ], ... ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN fhir:Citation.publicationForm.publishedIn.title [ string ]; # 0..1 Name of the database or title of the book or journal fhir:Citation.publicationForm.publishedIn.publisher [ Reference(Organization) ]; # 0..1 Name of the publisher fhir:Citation.publicationForm.publishedIn.publisherLocation [ string ]; # 0..1 Geographic location of the publisher fhir:Citation.publicationForm.publishedIn.startDate [ date ]; # 0..1 When the database was first available or when the book was published ]; fhir:Citation.publicationForm.periodicRelease [ # 0..* The specific issue in which the cited article resides fhir:Citation.publicationForm.periodicRelease.citedMedium [ CodeableConcept ]; # 0..1 Internet or Print fhir:Citation.publicationForm.periodicRelease.volume [ string ]; # 0..1 Volume number of journal in which the article is published fhir:Citation.publicationForm.periodicRelease.issue [ string ]; # 0..1 Issue, part or supplement of journal in which the article is published fhir:Citation.publicationForm.periodicRelease.dateOfPublication [ # 0..1 Defining the date on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.date [ date ]; # 0..1 Date on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.year [ string ]; # 0..1 Year on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.month [ string ]; # 0..1 Month on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.day [ string ]; # 0..1 Day on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.season [ string ]; # 0..1 Season on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.text [ string ]; # 0..1 Text representation of the date of which the issue of the journal was published ]; ], ...; fhir:Citation.publicationForm.articleDate [ dateTime ]; # 0..1 The date the article was added to the database, or the date the article was released fhir:Citation.publicationForm.revisionDate [ dateTime ]; # 0..1 The date the article was last revised or updated in the database fhir:Citation.publicationForm.language [ CodeableConcept ], ... ; # 0..* Language in which this form of the article is published fhir:Citation.publicationForm.pageString [ string ]; # 0..1 Used for full display of pagination fhir:Citation.publicationForm.firstPage [ string ]; # 0..1 Used for isolated representation of first page fhir:Citation.publicationForm.lastPage [ string ]; # 0..1 Used for isolated representation of last page fhir:Citation.publicationForm.pageCount [ string ]; # 0..1 Number of pages or screens ], ...; fhir:Citation.classifier [ CodeableConcept ], ... ; # 0..* Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical fhir:Citation.keywordList [ # 0..* Used to support keyword searches fhir:Citation.keywordList.owner [ string ]; # 0..1 Author, publisher, or custodian of the keyword list fhir:Citation.keywordList.keyword [ # 1..* For each keyword in the keyword list fhir:Citation.keywordList.keyword.majorTopic [ boolean ]; # 0..1 Whether or not it is a major topic fhir:Citation.keywordList.keyword.value [ string ]; # 1..1 The actual keyword ], ...; ], ...; fhir:Citation.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Link or citation to artifact associated with the referenced material fhir:Citation.note [ Annotation ], ... ; # 0..* Used for general notes and annotations not coded elsewhere fhir:Citation.medline [ # 0..1 These elements are items with values assigned by MEDLINE or PubMed management fhir:Citation.medline.state [ code ]; # 0..1 Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE fhir:Citation.medline.owner [ code ]; # 0..1 NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM fhir:Citation.medline.dateCreated [ date ]; # 0..1 Creation date fhir:Citation.medline.dateCompleted [ date ]; # 0..1 Completion date fhir:Citation.medline.dateRevised [ date ]; # 0..1 Revision date fhir:Citation.medline.dateOnPubMed [ # 0..* Date of PubMed publication fhir:Citation.medline.dateOnPubMed.publicationState [ code ]; # 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release fhir:Citation.medline.dateOnPubMed.date [ dateTime ]; # 0..1 PubMed Publication Date ], ...; fhir:Citation.medline.publicationState [ code ]; # 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release fhir:Citation.medline.relatedArticle [ # 0..* Citation details for the related article fhir:Citation.medline.relatedArticle.citationReference [ Reference(Citation) ]; # 0..1 Citation Resource for related article fhir:Citation.medline.relatedArticle.citationMarkdown [ markdown ]; # 0..1 Citation string for related article fhir:Citation.medline.relatedArticle.identifier [ Identifier ], ... ; # 0..* Citation identifier for the related article ], ...; ]; ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Citation | TU | DomainResource | A citation of a publication + 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 | |
url | Σ | 0..1 | uri | Canonical identifier for this citation, represented as a globally unique URI |
identifier | Σ | 0..* | Identifier | May include DOI, PMID, PMCID, etc. |
relatedIdentifier | Σ | 0..* | Identifier | May include trial registry identifiers |
version | Σ | 0..1 | string | Business version of the citation |
name | ΣI | 0..1 | string | Name for this citation (computer friendly) |
title | Σ | 0..1 | string | Name for this citation (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | The publisher of the Citation, not the publisher of the article being cited |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the citation | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for citation (if applicable) Jurisdiction (Extensible) |
purpose | 0..1 | markdown | Why this citation is defined | |
approvalDate | 0..1 | date | When the citation was approved by publisher | |
lastReviewDate | 0..1 | date | When the citation was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the citation is expected to be used |
summary | 0..* | BackboneElement | A human-readable display of the citation | |
style | 0..1 | CodeableConcept | Format for display of the citation CitationSummaryStyle (Extensible) | |
text | Σ | 1..1 | markdown | The human-readable display of the citation |
dateCited | Σ | 0..1 | dateTime | When the citation was cited |
variantCitation | 0..1 | BackboneElement | An alternative variant of the citation | |
type | 0..1 | CodeableConcept | Used to describe the reason for the variant citation, such as version or subpart specification CitationVariantType (Extensible) | |
value | 0..1 | string | Used to describe the specific variation, such as version number or subpart specification | |
baseCitation | 0..1 | Reference(Citation) | Base citation layer | |
articleTitle | 0..* | BackboneElement | The name of the article | |
type | 0..1 | CodeableConcept | Used to express the reason and specific aspect for any variant title, such as language AlternativeTitleType (Extensible) | |
language | 0..1 | CodeableConcept | Used to express the specific language Common Languages (Preferred but limited to AllLanguages) | |
text | 1..1 | markdown | Full title of the article | |
webLocation | 0..* | BackboneElement | Used for any URL for the article cited | |
type | 0..1 | CodeableConcept | Code the reason for different URLs, e.g. abstract and full-text ArticleUrlType (Extensible) | |
url | 0..1 | uri | The specific URL | |
abstract | 0..* | BackboneElement | Publisher-provided summary of the article | |
type | 0..1 | CodeableConcept | Used to express the reason for an additional or variant abstract, such as language AlternativeTitleType (Extensible) | |
language | 0..1 | CodeableConcept | Used to express the specific language Common Languages (Preferred but limited to AllLanguages) | |
text | 1..1 | markdown | Abstract content | |
copyright | 0..1 | markdown | Copyright notice for the abstract | |
contributorship | 0..1 | BackboneElement | Attribution of authors and other contributors | |
complete | 0..1 | boolean | Indicates if the list includes all authors and/or contributors | |
entry | 0..* | BackboneElement | An individual entity named in the list | |
name | 0..1 | HumanName | A name associated with the person | |
initials | 0..1 | string | Initials for forename | |
collectiveName | 0..1 | string | Used for collective or corporate name as an author | |
identifier | 0..* | Identifier | Author identifier, eg ORCID | |
affiliationInfo | 0..* | BackboneElement | Organizational affiliation | |
affiliation | 0..1 | string | Display for the organization | |
role | 0..1 | string | Role within the organization, such as professional title | |
identifier | 0..* | Identifier | Identifier for the organization | |
address | 0..* | Address | Physical mailing address | |
telecom | 0..* | ContactPoint | Email or telephone contact methods for | |
contribution | 0..* | CodeableConcept | The specific contributions CitationContribution (Extensible) | |
notAnAuthor | 0..1 | boolean | Used to identify non-author contributors | |
correspondingAuthor | 0..1 | boolean | Indication of which author is the corresponding author for the article cited | |
listOrder | 0..1 | positiveInt | Used to code order of authors | |
summary | 0..* | BackboneElement | Used to record a display of the author/contributor list without separate coding for each list member | |
type | 0..1 | CodeableConcept | Either authorList or contributorshipStatement ContributorSummaryType (Extensible) | |
style | 0..1 | CodeableConcept | The format for the display string ContributorSummaryStyle (Extensible) | |
source | 0..1 | CodeableConcept | Used to code the producer or rule for creating the display string ContributorSummarySource (Extensible) | |
value | 1..1 | markdown | The display string for the author list, contributor list, or contributorship statement | |
publicationForm | 0..* | BackboneElement | If multiple, used to represent alternative forms of the article that are not separate citations | |
publishingModel | 0..1 | CodeableConcept | Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic PublishingModelType (Extensible) | |
publishedIn | 0..1 | BackboneElement | The collection the cited article is published in | |
type | 0..1 | CodeableConcept | Periodical, database, or book PublishedInType (Extensible) | |
identifier | 0..* | Identifier | Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN | |
title | 0..1 | string | Name of the database or title of the book or journal | |
publisher | 0..1 | Reference(Organization) | Name of the publisher | |
publisherLocation | 0..1 | string | Geographic location of the publisher | |
startDate | 0..1 | date | When the database was first available or when the book was published | |
periodicRelease | 0..* | BackboneElement | The specific issue in which the cited article resides | |
citedMedium | 0..1 | CodeableConcept | Internet or Print JournalIssueMedium (Extensible) | |
volume | 0..1 | string | Volume number of journal in which the article is published | |
issue | 0..1 | string | Issue, part or supplement of journal in which the article is published | |
dateOfPublication | 0..1 | BackboneElement | Defining the date on which the issue of the journal was published | |
date | 0..1 | date | Date on which the issue of the journal was published | |
year | 0..1 | string | Year on which the issue of the journal was published | |
month | 0..1 | string | Month on which the issue of the journal was published | |
day | 0..1 | string | Day on which the issue of the journal was published | |
season | 0..1 | string | Season on which the issue of the journal was published | |
text | 0..1 | string | Text representation of the date of which the issue of the journal was published | |
articleDate | 0..1 | dateTime | The date the article was added to the database, or the date the article was released | |
revisionDate | 0..1 | dateTime | The date the article was last revised or updated in the database | |
language | 0..* | CodeableConcept | Language in which this form of the article is published Common Languages (Preferred but limited to AllLanguages) | |
pageString | 0..1 | string | Used for full display of pagination | |
firstPage | 0..1 | string | Used for isolated representation of first page | |
lastPage | 0..1 | string | Used for isolated representation of last page | |
pageCount | 0..1 | string | Number of pages or screens | |
classifier | 0..* | CodeableConcept | Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical CitationClassifier (Extensible) | |
keywordList | 0..* | BackboneElement | Used to support keyword searches | |
owner | 0..1 | string | Author, publisher, or custodian of the keyword list | |
keyword | 1..* | BackboneElement | For each keyword in the keyword list | |
majorTopic | 0..1 | boolean | Whether or not it is a major topic | |
value | 1..1 | string | The actual keyword | |
relatedArtifact | 0..* | RelatedArtifact | Link or citation to artifact associated with the referenced material | |
note | 0..* | Annotation | Used for general notes and annotations not coded elsewhere | |
medline | 0..1 | BackboneElement | These elements are items with values assigned by MEDLINE or PubMed management | |
state | 0..1 | code | Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE MedlineCitationStatus (Required) | |
owner | 0..1 | code | NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM MedlineCitationOwner (Required) | |
dateCreated | 0..1 | date | Creation date | |
dateCompleted | 0..1 | date | Completion date | |
dateRevised | 0..1 | date | Revision date | |
dateOnPubMed | 0..* | BackboneElement | Date of PubMed publication | |
publicationState | 0..1 | code | received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release PubMedPubStatus (Required) | |
date | 0..1 | dateTime | PubMed Publication Date | |
publicationState | 0..1 | code | received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release PubMedPubStatus (Required) | |
relatedArticle | 0..* | BackboneElement | Citation details for the related article | |
citationReference | 0..1 | Reference(Citation) | Citation Resource for related article | |
citationMarkdown | 0..1 | markdown | Citation string for related article | |
identifier | 0..* | Identifier | Citation identifier for the related article | |
Documentation for this format |
XML Template
<Citation xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this citation, represented as a globally unique URI --> <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier> <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier> <version value="[string]"/><!-- 0..1 Business version of the citation --> <name value="[string]"/><!-- 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 being cited --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the citation --> <useContext><!-- 0..* UsageContext The context that the 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 --> <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> <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> <dateCited value="[dateTime]"/><!-- 0..1 When the citation was cited --> <variantCitation> <!-- 0..1 An alternative variant of the citation --> <type><!-- 0..1 CodeableConcept Used to describe the reason for the variant citation, such as version or subpart specification --></type> <value value="[string]"/><!-- 0..1 Used to describe the specific variation, such as version number or subpart specification --> <baseCitation><!-- 0..1 Reference(Citation) Base citation layer --></baseCitation> </variantCitation> <articleTitle> <!-- 0..* The name of the article --> <type><!-- 0..1 CodeableConcept Used to express the reason and specific aspect for any variant title, such as language --></type> <language><!-- 0..1 CodeableConcept Used to express the specific language --></language> <text value="[markdown]"/><!-- 1..1 Full title of the article --> </articleTitle> <webLocation> <!-- 0..* Used for any URL for the article cited --> <type><!-- 0..1 CodeableConcept Code the reason for different URLs, e.g. abstract and full-text --></type> <url value="[uri]"/><!-- 0..1 The specific URL --> </webLocation> <abstract> <!-- 0..* Publisher-provided summary of the article --> <type><!-- 0..1 CodeableConcept Used to express the reason for an additional or variant abstract, such as language --></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> <contributorship> <!-- 0..1 Attribution of authors and other contributors --> <complete value="[boolean]"/><!-- 0..1 Indicates if the list includes all authors and/or contributors --> <entry> <!-- 0..* An individual entity named in the list --> <name><!-- 0..1 HumanName A name associated with the person --></name> <initials value="[string]"/><!-- 0..1 Initials for forename --> <collectiveName value="[string]"/><!-- 0..1 Used for collective or corporate name as an author --> <identifier><!-- 0..* Identifier Author identifier, eg ORCID --></identifier> <affiliationInfo> <!-- 0..* Organizational affiliation --> <affiliation value="[string]"/><!-- 0..1 Display for the organization --> <role value="[string]"/><!-- 0..1 Role within the organization, such as professional title --> <identifier><!-- 0..* Identifier Identifier for the organization --></identifier> </affiliationInfo> <address><!-- 0..* Address Physical mailing address --></address> <telecom><!-- 0..* ContactPoint Email or telephone contact methods for --></telecom> <contribution><!-- 0..* CodeableConcept The specific contributions --></contribution> <notAnAuthor value="[boolean]"/><!-- 0..1 Used to identify non-author contributors --> <correspondingAuthor value="[boolean]"/><!-- 0..1 Indication of which author is the corresponding author for the article cited --> <listOrder value="[positiveInt]"/><!-- 0..1 Used to code order of authors --> </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> <publicationForm> <!-- 0..* If multiple, used to represent alternative forms of the article that are not separate citations --> <publishingModel><!-- 0..1 CodeableConcept Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic --></publishingModel> <publishedIn> <!-- 0..1 The collection the cited article is published in --> <type><!-- 0..1 CodeableConcept 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 --> <startDate value="[date]"/><!-- 0..1 When the database was first available or when the book was published --> </publishedIn> <periodicRelease> <!-- 0..* The specific issue in which the cited article resides --> <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 --> <dateOfPublication> <!-- 0..1 Defining the date on which the issue of the journal was published --> <date value="[date]"/><!-- 0..1 Date on which the issue of the journal was published --> <year value="[string]"/><!-- 0..1 Year on which the issue of the journal was published --> <month value="[string]"/><!-- 0..1 Month on which the issue of the journal was published --> <day value="[string]"/><!-- 0..1 Day on which the issue of the journal was published --> <season value="[string]"/><!-- 0..1 Season on which the issue of the journal was published --> <text value="[string]"/><!-- 0..1 Text representation of the date of which the issue of the journal was published --> </dateOfPublication> </periodicRelease> <articleDate value="[dateTime]"/><!-- 0..1 The date the article was added to the database, or the date the article was released --> <revisionDate 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> <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 --> </publicationForm> <classifier><!-- 0..* CodeableConcept Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical --></classifier> <keywordList> <!-- 0..* Used to support keyword searches --> <owner value="[string]"/><!-- 0..1 Author, publisher, or custodian of the keyword list --> <keyword> <!-- 1..* For each keyword in the keyword list --> <majorTopic value="[boolean]"/><!-- 0..1 Whether or not it is a major topic --> <value value="[string]"/><!-- 1..1 The actual keyword --> </keyword> </keywordList> <relatedArtifact><!-- 0..* RelatedArtifact Link or citation to artifact associated with the referenced material --></relatedArtifact> <note><!-- 0..* Annotation Used for general notes and annotations not coded elsewhere --></note> <medline> <!-- 0..1 These elements are items with values assigned by MEDLINE or PubMed management --> <state value="[code]"/><!-- 0..1 Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE --> <owner value="[code]"/><!-- 0..1 NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM --> <dateCreated value="[date]"/><!-- 0..1 Creation date --> <dateCompleted value="[date]"/><!-- 0..1 Completion date --> <dateRevised value="[date]"/><!-- 0..1 Revision date --> <dateOnPubMed> <!-- 0..* Date of PubMed publication --> <publicationState value="[code]"/><!-- 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release --> <date value="[dateTime]"/><!-- 0..1 PubMed Publication Date --> </dateOnPubMed> <publicationState value="[code]"/><!-- 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release --> <relatedArticle> <!-- 0..* Citation details for the related article --> <citationReference><!-- 0..1 Reference(Citation) Citation Resource for related article --></citationReference> <citationMarkdown value="[markdown]"/><!-- 0..1 Citation string for related article --> <identifier><!-- 0..* Identifier Citation identifier for the related article --></identifier> </relatedArticle> </medline> </Citation>
JSON Template
{ "resourceType" : "Citation", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Canonical identifier for this citation, represented as a globally unique URI "identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc. "relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers "version" : "<string>", // Business version of the citation "name" : "<string>", // C? 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 being cited "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the citation "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for citation (if applicable) "purpose" : "<markdown>", // Why this citation is defined "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 "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 }], "dateCited" : "<dateTime>", // When the citation was cited "variantCitation" : { // An alternative variant of the citation "type" : { CodeableConcept }, // Used to describe the reason for the variant citation, such as version or subpart specification "value" : "<string>", // Used to describe the specific variation, such as version number or subpart specification "baseCitation" : { Reference(Citation) } // Base citation layer }, "articleTitle" : [{ // The name of the article "type" : { CodeableConcept }, // Used to express the reason and specific aspect for any variant title, such as language "language" : { CodeableConcept }, // Used to express the specific language "text" : "<markdown>" // R! Full title of the article }], "webLocation" : [{ // Used for any URL for the article cited "type" : { CodeableConcept }, // Code the reason for different URLs, e.g. abstract and full-text "url" : "<uri>" // The specific URL }], "abstract" : [{ // Publisher-provided summary of the article "type" : { CodeableConcept }, // Used to express the reason for an additional or variant abstract, such as language "language" : { CodeableConcept }, // Used to express the specific language "text" : "<markdown>", // R! Abstract content "copyright" : "<markdown>" // Copyright notice for the abstract }], "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 "name" : { HumanName }, // A name associated with the person "initials" : "<string>", // Initials for forename "collectiveName" : "<string>", // Used for collective or corporate name as an author "identifier" : [{ Identifier }], // Author identifier, eg ORCID "affiliationInfo" : [{ // Organizational affiliation "affiliation" : "<string>", // Display for the organization "role" : "<string>", // Role within the organization, such as professional title "identifier" : [{ Identifier }] // Identifier for the organization }], "address" : [{ Address }], // Physical mailing address "telecom" : [{ ContactPoint }], // Email or telephone contact methods for "contribution" : [{ CodeableConcept }], // The specific contributions "notAnAuthor" : <boolean>, // Used to identify non-author contributors "correspondingAuthor" : <boolean>, // Indication of which author is the corresponding author for the article cited "listOrder" : "<positiveInt>" // Used to code order of authors }], "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 }] }, "publicationForm" : [{ // If multiple, used to represent alternative forms of the article that are not separate citations "publishingModel" : { CodeableConcept }, // Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic "publishedIn" : { // The collection the cited article is published in "type" : { CodeableConcept }, // 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 "startDate" : "<date>" // When the database was first available or when the book was published }, "periodicRelease" : [{ // The specific issue in which the cited article resides "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 "dateOfPublication" : { // Defining the date on which the issue of the journal was published "date" : "<date>", // Date on which the issue of the journal was published "year" : "<string>", // Year on which the issue of the journal was published "month" : "<string>", // Month on which the issue of the journal was published "day" : "<string>", // Day on which the issue of the journal was published "season" : "<string>", // Season on which the issue of the journal was published "text" : "<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 "revisionDate" : "<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 "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 }], "classifier" : [{ CodeableConcept }], // Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical "keywordList" : [{ // Used to support keyword searches "owner" : "<string>", // Author, publisher, or custodian of the keyword list "keyword" : [{ // R! For each keyword in the keyword list "majorTopic" : <boolean>, // Whether or not it is a major topic "value" : "<string>" // R! The actual keyword }] }], "relatedArtifact" : [{ RelatedArtifact }], // Link or citation to artifact associated with the referenced material "note" : [{ Annotation }], // Used for general notes and annotations not coded elsewhere "medline" : { // These elements are items with values assigned by MEDLINE or PubMed management "state" : "<code>", // Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE "owner" : "<code>", // NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM "dateCreated" : "<date>", // Creation date "dateCompleted" : "<date>", // Completion date "dateRevised" : "<date>", // Revision date "dateOnPubMed" : [{ // Date of PubMed publication "publicationState" : "<code>", // received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release "date" : "<dateTime>" // PubMed Publication Date }], "publicationState" : "<code>", // received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release "relatedArticle" : [{ // Citation details for the related article "citationReference" : { Reference(Citation) }, // Citation Resource for related article "citationMarkdown" : "<markdown>", // Citation string for related article "identifier" : [{ Identifier }] // Citation identifier for the related article }] } }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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..* May include DOI, PMID, PMCID, etc. fhir:Citation.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers fhir:Citation.version [ string ]; # 0..1 Business version of the citation fhir:Citation.name [ string ]; # 0..1 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 being cited fhir:Citation.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:Citation.description [ markdown ]; # 0..1 Natural language description of the citation fhir:Citation.useContext [ UsageContext ], ... ; # 0..* The context that the 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.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.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.dateCited [ dateTime ]; # 0..1 When the citation was cited fhir:Citation.variantCitation [ # 0..1 An alternative variant of the citation fhir:Citation.variantCitation.type [ CodeableConcept ]; # 0..1 Used to describe the reason for the variant citation, such as version or subpart specification fhir:Citation.variantCitation.value [ string ]; # 0..1 Used to describe the specific variation, such as version number or subpart specification fhir:Citation.variantCitation.baseCitation [ Reference(Citation) ]; # 0..1 Base citation layer ]; fhir:Citation.articleTitle [ # 0..* The name of the article fhir:Citation.articleTitle.type [ CodeableConcept ]; # 0..1 Used to express the reason and specific aspect for any variant title, such as language fhir:Citation.articleTitle.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.articleTitle.text [ markdown ]; # 1..1 Full title of the article ], ...; fhir:Citation.webLocation [ # 0..* Used for any URL for the article cited fhir:Citation.webLocation.type [ CodeableConcept ]; # 0..1 Code the reason for different URLs, e.g. abstract and full-text fhir:Citation.webLocation.url [ uri ]; # 0..1 The specific URL ], ...; fhir:Citation.abstract [ # 0..* Publisher-provided summary of the article fhir:Citation.abstract.type [ CodeableConcept ]; # 0..1 Used to express the reason for an additional or variant abstract, such as language fhir:Citation.abstract.language [ CodeableConcept ]; # 0..1 Used to express the specific language fhir:Citation.abstract.text [ markdown ]; # 1..1 Abstract content fhir:Citation.abstract.copyright [ markdown ]; # 0..1 Copyright notice for the abstract ], ...; fhir:Citation.contributorship [ # 0..1 Attribution of authors and other contributors fhir:Citation.contributorship.complete [ boolean ]; # 0..1 Indicates if the list includes all authors and/or contributors fhir:Citation.contributorship.entry [ # 0..* An individual entity named in the list fhir:Citation.contributorship.entry.name [ HumanName ]; # 0..1 A name associated with the person fhir:Citation.contributorship.entry.initials [ string ]; # 0..1 Initials for forename fhir:Citation.contributorship.entry.collectiveName [ string ]; # 0..1 Used for collective or corporate name as an author fhir:Citation.contributorship.entry.identifier [ Identifier ], ... ; # 0..* Author identifier, eg ORCID fhir:Citation.contributorship.entry.affiliationInfo [ # 0..* Organizational affiliation fhir:Citation.contributorship.entry.affiliationInfo.affiliation [ string ]; # 0..1 Display for the organization fhir:Citation.contributorship.entry.affiliationInfo.role [ string ]; # 0..1 Role within the organization, such as professional title fhir:Citation.contributorship.entry.affiliationInfo.identifier [ Identifier ], ... ; # 0..* Identifier for the organization ], ...; fhir:Citation.contributorship.entry.address [ Address ], ... ; # 0..* Physical mailing address fhir:Citation.contributorship.entry.telecom [ ContactPoint ], ... ; # 0..* Email or telephone contact methods for fhir:Citation.contributorship.entry.contribution [ CodeableConcept ], ... ; # 0..* The specific contributions fhir:Citation.contributorship.entry.notAnAuthor [ boolean ]; # 0..1 Used to identify non-author contributors fhir:Citation.contributorship.entry.correspondingAuthor [ boolean ]; # 0..1 Indication of which author is the corresponding author for the article cited fhir:Citation.contributorship.entry.listOrder [ positiveInt ]; # 0..1 Used to code order of authors ], ...; fhir:Citation.contributorship.summary [ # 0..* Used to record a display of the author/contributor list without separate coding for each list member fhir:Citation.contributorship.summary.type [ CodeableConcept ]; # 0..1 Either authorList or contributorshipStatement fhir:Citation.contributorship.summary.style [ CodeableConcept ]; # 0..1 The format for the display string fhir:Citation.contributorship.summary.source [ CodeableConcept ]; # 0..1 Used to code the producer or rule for creating the display string fhir:Citation.contributorship.summary.value [ markdown ]; # 1..1 The display string for the author list, contributor list, or contributorship statement ], ...; ]; fhir:Citation.publicationForm [ # 0..* If multiple, used to represent alternative forms of the article that are not separate citations fhir:Citation.publicationForm.publishingModel [ CodeableConcept ]; # 0..1 Identify the medium/media in which the cited article is published, eg print, electronic or print-electronic fhir:Citation.publicationForm.publishedIn [ # 0..1 The collection the cited article is published in fhir:Citation.publicationForm.publishedIn.type [ CodeableConcept ]; # 0..1 Periodical, database, or book fhir:Citation.publicationForm.publishedIn.identifier [ Identifier ], ... ; # 0..* Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN fhir:Citation.publicationForm.publishedIn.title [ string ]; # 0..1 Name of the database or title of the book or journal fhir:Citation.publicationForm.publishedIn.publisher [ Reference(Organization) ]; # 0..1 Name of the publisher fhir:Citation.publicationForm.publishedIn.publisherLocation [ string ]; # 0..1 Geographic location of the publisher fhir:Citation.publicationForm.publishedIn.startDate [ date ]; # 0..1 When the database was first available or when the book was published ]; fhir:Citation.publicationForm.periodicRelease [ # 0..* The specific issue in which the cited article resides fhir:Citation.publicationForm.periodicRelease.citedMedium [ CodeableConcept ]; # 0..1 Internet or Print fhir:Citation.publicationForm.periodicRelease.volume [ string ]; # 0..1 Volume number of journal in which the article is published fhir:Citation.publicationForm.periodicRelease.issue [ string ]; # 0..1 Issue, part or supplement of journal in which the article is published fhir:Citation.publicationForm.periodicRelease.dateOfPublication [ # 0..1 Defining the date on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.date [ date ]; # 0..1 Date on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.year [ string ]; # 0..1 Year on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.month [ string ]; # 0..1 Month on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.day [ string ]; # 0..1 Day on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.season [ string ]; # 0..1 Season on which the issue of the journal was published fhir:Citation.publicationForm.periodicRelease.dateOfPublication.text [ string ]; # 0..1 Text representation of the date of which the issue of the journal was published ]; ], ...; fhir:Citation.publicationForm.articleDate [ dateTime ]; # 0..1 The date the article was added to the database, or the date the article was released fhir:Citation.publicationForm.revisionDate [ dateTime ]; # 0..1 The date the article was last revised or updated in the database fhir:Citation.publicationForm.language [ CodeableConcept ], ... ; # 0..* Language in which this form of the article is published fhir:Citation.publicationForm.pageString [ string ]; # 0..1 Used for full display of pagination fhir:Citation.publicationForm.firstPage [ string ]; # 0..1 Used for isolated representation of first page fhir:Citation.publicationForm.lastPage [ string ]; # 0..1 Used for isolated representation of last page fhir:Citation.publicationForm.pageCount [ string ]; # 0..1 Number of pages or screens ], ...; fhir:Citation.classifier [ CodeableConcept ], ... ; # 0..* Used for many classifiers including PublicationType, CitationSubset, MeshHeading, Chemical fhir:Citation.keywordList [ # 0..* Used to support keyword searches fhir:Citation.keywordList.owner [ string ]; # 0..1 Author, publisher, or custodian of the keyword list fhir:Citation.keywordList.keyword [ # 1..* For each keyword in the keyword list fhir:Citation.keywordList.keyword.majorTopic [ boolean ]; # 0..1 Whether or not it is a major topic fhir:Citation.keywordList.keyword.value [ string ]; # 1..1 The actual keyword ], ...; ], ...; fhir:Citation.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Link or citation to artifact associated with the referenced material fhir:Citation.note [ Annotation ], ... ; # 0..* Used for general notes and annotations not coded elsewhere fhir:Citation.medline [ # 0..1 These elements are items with values assigned by MEDLINE or PubMed management fhir:Citation.medline.state [ code ]; # 0..1 Completed | In-Process | PubMed-not-MEDLINE | In-Data-Review | Publisher | MEDLINE | OLDMEDLINE fhir:Citation.medline.owner [ code ]; # 0..1 NLM | NASA | PIP | KIE | HSR | HMD | SIS | NOTNLM fhir:Citation.medline.dateCreated [ date ]; # 0..1 Creation date fhir:Citation.medline.dateCompleted [ date ]; # 0..1 Completion date fhir:Citation.medline.dateRevised [ date ]; # 0..1 Revision date fhir:Citation.medline.dateOnPubMed [ # 0..* Date of PubMed publication fhir:Citation.medline.dateOnPubMed.publicationState [ code ]; # 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release fhir:Citation.medline.dateOnPubMed.date [ dateTime ]; # 0..1 PubMed Publication Date ], ...; fhir:Citation.medline.publicationState [ code ]; # 0..1 received | accepted | epublish | ppublish | revised | aheadofprint | retracted | ecollection | pmc | pmcr | pubmed | pubmedr | premedline | medline | medliner | entrez | pmc-release fhir:Citation.medline.relatedArticle [ # 0..* Citation details for the related article fhir:Citation.medline.relatedArticle.citationReference [ Reference(Citation) ]; # 0..1 Citation Resource for related article fhir:Citation.medline.relatedArticle.citationMarkdown [ markdown ]; # 0..1 Citation string for related article fhir:Citation.medline.relatedArticle.identifier [ Identifier ], ... ; # 0..* Citation identifier for the related article ], ...; ]; ]
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
Path | Definition | Type | Reference |
---|---|---|---|
Citation.status | Required | PublicationStatus | |
Citation.jurisdiction | Extensible | Jurisdiction ValueSet | |
Citation.summary.style | Extensible | CitationSummaryStyle | |
Citation.variantCitation.type | Extensible | CitationVariantType | |
Citation.articleTitle.type | Extensible | AlternativeTitleType | |
Citation.articleTitle.language | A human language. | Preferred, but limited to AllLanguages | CommonLanguages |
Citation.webLocation.type | Extensible | ArticleUrlType | |
Citation.abstract.type | Extensible | AlternativeTitleType | |
Citation.abstract.language | A human language. | Preferred, but limited to AllLanguages | CommonLanguages |
Citation.contributorship.entry.contribution | Extensible | CitationContribution | |
Citation.contributorship.summary.type | Extensible | ContributorSummaryType | |
Citation.contributorship.summary.style | Extensible | ContributorSummaryStyle | |
Citation.contributorship.summary.source | Extensible | ContributorSummarySource | |
Citation.publicationForm.publishingModel | Extensible | PublishingModelType | |
Citation.publicationForm.publishedIn.type | Extensible | PublishedInType | |
Citation.publicationForm.periodicRelease.citedMedium | Extensible | JournalIssueMedium | |
Citation.publicationForm.language | A human language. | Preferred, but limited to AllLanguages | CommonLanguages |
Citation.classifier | Extensible | CitationClassifier | |
Citation.medline.state | Required | MedlineCitationStatus | |
Citation.medline.owner | Required | MedlineCitationOwner | |
Citation.medline.dateOnPubMed.publicationState | Required | PubMedPubStatus | |
Citation.medline.publicationState | Required | PubMedPubStatus |
id | Level | Location | Description | Expression |
cnl-0 | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
context | token | A use context assigned to the citation | (Citation.useContext.value as CodeableConcept) | |
context-quantity | quantity | A quantity- or range-valued use context assigned to the citation | (Citation.useContext.value as Quantity) | (Citation.useContext.value as Range) | |
context-type | token | A type of use context assigned to the citation | Citation.useContext.code | |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the citation | On Citation.useContext: context-type: code context-quantity: value.as(Quantity) | value.as(Range) | |
context-type-value | composite | A use context type and value assigned to the citation | On Citation.useContext: context-type: code context: value.as(CodeableConcept) | |
date N | date | The citation publication date | Citation.date | |
description N | string | The description of the citation | Citation.description | |
effective | date | The time during which the citation is intended to be in use | Citation.effectivePeriod | |
identifier | token | External identifier for the citation | Citation.identifier | |
jurisdiction | token | Intended jurisdiction for the citation | Citation.jurisdiction | |
name N | string | Computationally friendly name of the citation | Citation.name | |
publisher N | string | Name of the publisher of the citation | Citation.publisher | |
status N | token | The current status of the citation | Citation.status | |
title N | string | The human-friendly name of the citation | Citation.title | |
url N | uri | The uri that identifies the citation | Citation.url | |
version N | token | The business version of the citation | Citation.version |