Release 5 Draft Ballot

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

Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Citation resource.

Citation
Element IdCitation
Definition

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.

Cardinality0..*
TypeMetadataResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
Citation.url
Element IdCitation.url
Definition

An absolute URI that is used to identify this citation when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers.

Cardinality0..1
Typeuri
Requirements

Allows the citation to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

Citation.identifier
Element IdCitation.identifier
Definition

A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable identifiers to be associated with this citation.

Summarytrue
Comments

May include DOI, PMID, PMCID, etc. This element will contain unique identifiers that support de-duplication of citations. This identifier can be valid for only one citation resource.

Citation.version
Element IdCitation.version
Definition

The identifier that is used to identify this version of the citation when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the citation author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different citation instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the citation with the format [url]|[version].

Citation.name
Element IdCitation.name
Definition

A natural language name identifying the citation. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
Citation.title
Element IdCitation.title
Definition

A short, descriptive, user-friendly title for the citation.

Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Citation.status
Element IdCitation.status
Definition

The status of this summary. Enables tracking the life-cycle of the content.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Requirements

Allows filtering of citations that are appropriate for use versus not.

Summarytrue
Comments

Allows filtering of summarys s that are appropriate for use versus not.

Citation.experimental
Element IdCitation.experimental
Definition

A Boolean value to indicate that this citation is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Cardinality0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level citation.

Summarytrue
Comments

Allows filtering of citations that are appropriate for use versus not.

Citation.date
Element IdCitation.date
Definition

The date (and optionally time) when the citation was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the citation changes.

Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the citation. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Citation.publisher
Element IdCitation.publisher
Definition

The name of the organization or individual that published the citation.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the citation. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the citation is the organization or individual primarily responsible for the maintenance and upkeep of the citation. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the citation. This item SHOULD be populated unless the information is available from context.

Citation.contact
Element IdCitation.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

Citation.description
Element IdCitation.description
Definition

A free text natural language description of the citation from a consumer's perspective.

Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This description can be used to capture details such as why the citation was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the citation as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the citation is presumed to be the predominant language in the place the citation was created).

Citation.useContext
Element IdCitation.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate citation instances.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Citation.jurisdiction
Element IdCitation.jurisdiction
Definition

A legal or geographic region in which the citation is intended to be used.

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the citation to be used in jurisdictions other than those for which it was originally designed or intended.

Citation.purpose
Element IdCitation.purpose
Definition

Explanation of why this citation is needed and why it has been designed as it has.

Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the citation. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this citation.

Citation.copyright
Element IdCitation.copyright
Definition

Use and/or publishing restrictions for the Citation, not for the cited artifact.

Cardinality0..1
Typemarkdown
Summaryfalse
Citation.approvalDate
Element IdCitation.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Cardinality0..1
Typedate
Summaryfalse
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Citation.lastReviewDate
Element IdCitation.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Summaryfalse
Comments

If specified, this date follows the original approval date.

Citation.effectivePeriod
Element IdCitation.effectivePeriod
Definition

The period during which the citation content was or is planned to be in active use.

Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the citation are or are expected to be used instead.

Summarytrue
Comments

The effective period for a citation determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Citation.author
Element IdCitation.author
Definition

Who authored the Citation.

Cardinality0..*
TypeContactDetail
Summaryfalse
Citation.editor
Element IdCitation.editor
Definition

Who edited the Citation.

Cardinality0..*
TypeContactDetail
Summaryfalse
Citation.reviewer
Element IdCitation.reviewer
Definition

Who reviewed the Citation.

Cardinality0..*
TypeContactDetail
Summaryfalse
Citation.endorser
Element IdCitation.endorser
Definition

Who endorsed the Citation.

Cardinality0..*
TypeContactDetail
Summaryfalse
Citation.summary
Element IdCitation.summary
Definition

A human-readable display of the citation.

Cardinality0..*
Summaryfalse
Citation.summary.style
Element IdCitation.summary.style
Definition

Format for display of the citation.

Cardinality0..1
Terminology BindingCitationSummaryStyle (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.summary.text
Element IdCitation.summary.text
Definition

The human-readable display of the citation.

Cardinality1..1
Typemarkdown
Summarytrue
Citation.classification
Element IdCitation.classification
Definition

The assignment to an organizing scheme.

Cardinality0..*
Summaryfalse
Citation.classification.type
Element IdCitation.classification.type
Definition

The kind of classifier (e.g. publication type, keyword).

Cardinality0..1
Terminology BindingCitationClassificationType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.classification.classifier
Element IdCitation.classification.classifier
Definition

The specific classification value.

Cardinality0..*
Terminology BindingCitationArtifactClassifier (Example)
TypeCodeableConcept
Summaryfalse
Citation.note
Element IdCitation.note
Definition

Used for general notes and annotations not coded elsewhere.

Cardinality0..*
TypeAnnotation
Summaryfalse
Citation.currentState
Element IdCitation.currentState
Definition

The status of the citation.

Cardinality0..*
Terminology BindingCitationStatusType (Example)
TypeCodeableConcept
Summaryfalse
Citation.statusDate
Element IdCitation.statusDate
Definition

An effective date or period for a status of the citation.

Cardinality0..*
Summaryfalse
Citation.statusDate.activity
Element IdCitation.statusDate.activity
Definition

Classification of the status.

Cardinality1..1
Terminology BindingCitationStatusType (Example)
TypeCodeableConcept
Summaryfalse
Citation.statusDate.actual
Element IdCitation.statusDate.actual
Definition

Either occurred or expected.

Cardinality0..1
Typeboolean
Summaryfalse
Citation.statusDate.period
Element IdCitation.statusDate.period
Definition

When the status started and/or ended.

Cardinality1..1
TypePeriod
Summaryfalse
Comments

For an instance, place the same value in both start and end elements.

Citation.relatesTo
Element IdCitation.relatesTo
Definition

Artifact related to the Citation Resource.

Cardinality0..*
TypeRelatedArtifact
Summaryfalse
Citation.citedArtifact
Element IdCitation.citedArtifact
Definition

The article or artifact being described.

Cardinality0..1
Summaryfalse
Citation.citedArtifact.identifier
Element IdCitation.citedArtifact.identifier
Definition

A formal identifier that is used to identify this citation when it is represented in other formats, or referenced in a specification, model, design or an instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable identifiers to be associated with this citation.

Summarytrue
Comments

May include DOI, PMID, PMCID, etc. This element will contain unique identifiers that support de-duplication of citations. This identifier can be valid for only one citation resource.

Citation.citedArtifact.relatedIdentifier
Element IdCitation.citedArtifact.relatedIdentifier
Definition

A formal identifier that is used to identify things closely related to this citation.

Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable identifiers to be associated with this citation.

Summarytrue
Comments

May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This identifier can be valid for multiple citation resources.

Citation.citedArtifact.dateAccessed
Element IdCitation.citedArtifact.dateAccessed
Definition

When the cited artifact was accessed.

Cardinality0..1
TypedateTime
Summarytrue
Citation.citedArtifact.version
Element IdCitation.citedArtifact.version
Definition

The defined version of the cited artifact.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Summaryfalse
Citation.citedArtifact.version.value
Element IdCitation.citedArtifact.version.value
Definition

The version number or other version identifier.

Cardinality1..1
Typestring
Summaryfalse
Citation.citedArtifact.version.baseCitation
Element IdCitation.citedArtifact.version.baseCitation
Definition

Citation for the main version of the cited artifact.

Cardinality0..1
TypeReference(Citation)
Summaryfalse
Citation.citedArtifact.currentState
Element IdCitation.citedArtifact.currentState
Definition

The status of the cited artifact.

Cardinality0..*
Terminology BindingCitedArtifactStatusType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.statusDate
Element IdCitation.citedArtifact.statusDate
Definition

An effective date or period for a status of the cited artifact.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.statusDate.activity
Element IdCitation.citedArtifact.statusDate.activity
Definition

Classification of the status.

Cardinality1..1
Terminology BindingCitedArtifactStatusType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.statusDate.actual
Element IdCitation.citedArtifact.statusDate.actual
Definition

Either occurred or expected.

Cardinality0..1
Typeboolean
Summaryfalse
Citation.citedArtifact.statusDate.period
Element IdCitation.citedArtifact.statusDate.period
Definition

When the status started and/or ended.

Cardinality1..1
TypePeriod
Summaryfalse
Comments

For an instance, place the same value in both start and end elements.

Citation.citedArtifact.title
Element IdCitation.citedArtifact.title
Definition

The title details of the article or artifact.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.title.type
Element IdCitation.citedArtifact.title.type
Definition

Used to express the reason or specific aspect for the title.

Cardinality0..*
Terminology BindingTitleType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.title.language
Element IdCitation.citedArtifact.title.language
Definition

Used to express the specific language.

Cardinality0..1
Terminology BindingCommon Languages (Preferred)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.title.text
Element IdCitation.citedArtifact.title.text
Definition

The title of the article or artifact.

Cardinality1..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.abstract
Element IdCitation.citedArtifact.abstract
Definition

Summary of the article or artifact.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.abstract.type
Element IdCitation.citedArtifact.abstract.type
Definition

Used to express the reason or specific aspect for the abstract.

Cardinality0..1
Terminology BindingCitedArtifactAbstractType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.abstract.language
Element IdCitation.citedArtifact.abstract.language
Definition

Used to express the specific language.

Cardinality0..1
Terminology BindingCommon Languages (Preferred)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.abstract.text
Element IdCitation.citedArtifact.abstract.text
Definition

Abstract content.

Cardinality1..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.abstract.copyright
Element IdCitation.citedArtifact.abstract.copyright
Definition

Copyright notice for the abstract.

Cardinality0..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.part
Element IdCitation.citedArtifact.part
Definition

The component of the article or artifact.

Cardinality0..1
Summaryfalse
Citation.citedArtifact.part.type
Element IdCitation.citedArtifact.part.type
Definition

The kind of component.

Cardinality0..1
Terminology BindingCitedArtifactPartType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.part.value
Element IdCitation.citedArtifact.part.value
Definition

The specification of the component.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.part.baseCitation
Element IdCitation.citedArtifact.part.baseCitation
Definition

The citation for the full article or artifact.

Cardinality0..1
TypeReference(Citation)
Summaryfalse
Citation.citedArtifact.relatesTo
Element IdCitation.citedArtifact.relatesTo
Definition

The artifact related to the cited artifact.

Cardinality0..*
TypeRelatedArtifact
Summaryfalse
Citation.citedArtifact.publicationForm
Element IdCitation.citedArtifact.publicationForm
Definition

If multiple, used to represent alternative forms of the article that are not separate citations.

Cardinality0..*
Summaryfalse
Comments

A common use is a journal article with a publication date and pagination for a print version and a different publication date for the online version of the same article.

Citation.citedArtifact.publicationForm.publishedIn
Element IdCitation.citedArtifact.publicationForm.publishedIn
Definition

The collection the cited article or artifact is published in.

Cardinality0..1
Summaryfalse
Citation.citedArtifact.publicationForm.publishedIn.type
Element IdCitation.citedArtifact.publicationForm.publishedIn.type
Definition

Kind of container (e.g. Periodical, database, or book).

Cardinality0..1
Terminology BindingPublishedInType (Extensible)
TypeCodeableConcept
Summaryfalse
Comments

Journals and newspapers are coded as Periodical.

Citation.citedArtifact.publicationForm.publishedIn.identifier
Element IdCitation.citedArtifact.publicationForm.publishedIn.identifier
Definition

Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
Citation.citedArtifact.publicationForm.publishedIn.title
Element IdCitation.citedArtifact.publicationForm.publishedIn.title
Definition

Name of the database or title of the book or journal.

Cardinality0..1
Typestring
Summaryfalse
Comments

ClinicalTrials.gov is a name of a database.

Citation.citedArtifact.publicationForm.publishedIn.publisher
Element IdCitation.citedArtifact.publicationForm.publishedIn.publisher
Definition

Name of the publisher.

Cardinality0..1
TypeReference(Organization)
Summaryfalse
Citation.citedArtifact.publicationForm.publishedIn.publisherLocation
Element IdCitation.citedArtifact.publicationForm.publishedIn.publisherLocation
Definition

Geographic location of the publisher.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease
Element IdCitation.citedArtifact.publicationForm.periodicRelease
Definition

The specific issue in which the cited article resides.

Cardinality0..1
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.citedMedium
Element IdCitation.citedArtifact.publicationForm.periodicRelease.citedMedium
Definition

Describes the form of the medium cited. Common codes are "Internet" or "Print".

Cardinality0..1
Terminology BindingCitedMedium (Extensible)
TypeCodeableConcept
Summaryfalse
Comments

National Library of Medicine uses the codes "Internet" or "Print".

Citation.citedArtifact.publicationForm.periodicRelease.volume
Element IdCitation.citedArtifact.publicationForm.periodicRelease.volume
Definition

Volume number of journal in which the article is published.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.issue
Element IdCitation.citedArtifact.publicationForm.periodicRelease.issue
Definition

Issue, part or supplement of journal in which the article is published.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication
Element IdCitation.citedArtifact.publicationForm.periodicRelease.dateOfPublication
Definition

Defining the date on which the issue of the journal was published.

Cardinality0..1
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.date
Element IdCitation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.date
Definition

Date on which the issue of the journal was published.

Cardinality0..1
Typedate
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.year
Element IdCitation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.year
Definition

Year on which the issue of the journal was published.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.month
Element IdCitation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.month
Definition

Month on which the issue of the journal was published.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.day
Element IdCitation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.day
Definition

Day on which the issue of the journal was published.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.season
Element IdCitation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.season
Definition

Spring, Summer, Fall/Autumn, Winter.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.text
Element IdCitation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.text
Definition

Text representation of the date of which the issue of the journal was published.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.articleDate
Element IdCitation.citedArtifact.publicationForm.articleDate
Definition

The date the article was added to the database, or the date the article was released (which may differ from the journal issue publication date).

Cardinality0..1
TypedateTime
Summaryfalse
Citation.citedArtifact.publicationForm.lastRevisionDate
Element IdCitation.citedArtifact.publicationForm.lastRevisionDate
Definition

The date the article was last revised or updated in the database.

Cardinality0..1
TypedateTime
Summaryfalse
Citation.citedArtifact.publicationForm.language
Element IdCitation.citedArtifact.publicationForm.language
Definition

Language in which this form of the article is published.

Cardinality0..*
Terminology BindingCommon Languages (Preferred)
TypeCodeableConcept
Summaryfalse
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Citation.citedArtifact.publicationForm.accessionNumber
Element IdCitation.citedArtifact.publicationForm.accessionNumber
Definition

Entry number or identifier for inclusion in a database.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.pageString
Element IdCitation.citedArtifact.publicationForm.pageString
Definition

Used for full display of pagination.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.firstPage
Element IdCitation.citedArtifact.publicationForm.firstPage
Definition

Used for isolated representation of first page.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.lastPage
Element IdCitation.citedArtifact.publicationForm.lastPage
Definition

Used for isolated representation of last page.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.pageCount
Element IdCitation.citedArtifact.publicationForm.pageCount
Definition

Actual or approximate number of pages or screens.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.publicationForm.copyright
Element IdCitation.citedArtifact.publicationForm.copyright
Definition

Copyright notice for the full article or artifact.

Cardinality0..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.webLocation
Element IdCitation.citedArtifact.webLocation
Definition

Used for any URL for the article or artifact cited.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.webLocation.type
Element IdCitation.citedArtifact.webLocation.type
Definition

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

Cardinality0..1
Terminology BindingArticleUrlType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.webLocation.url
Element IdCitation.citedArtifact.webLocation.url
Definition

The specific URL.

Cardinality0..1
Typeuri
Summaryfalse
Comments

Persistent URLs, like doi, are preferred.

Citation.citedArtifact.classification
Element IdCitation.citedArtifact.classification
Definition

The assignment to an organizing scheme.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.classification.type
Element IdCitation.citedArtifact.classification.type
Definition

The kind of classifier (e.g. publication type, keyword).

Cardinality0..1
Terminology BindingCitedArtifactClassificationType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.classification.classifier
Element IdCitation.citedArtifact.classification.classifier
Definition

The specific classification value.

Cardinality0..*
Terminology BindingCitationArtifactClassifier (Example)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.classification.whoClassified
Element IdCitation.citedArtifact.classification.whoClassified
Definition

Provenance and copyright of classification.

Cardinality0..1
Summaryfalse
Citation.citedArtifact.classification.whoClassified.person
Element IdCitation.citedArtifact.classification.whoClassified.person
Definition

Person who created the classification.

Cardinality0..1
TypeReference(Person | Practitioner)
PatternsReference(Person,Practitioner): No common pattern
Summaryfalse
Citation.citedArtifact.classification.whoClassified.organization
Element IdCitation.citedArtifact.classification.whoClassified.organization
Definition

Organization who created the classification.

Cardinality0..1
TypeReference(Organization)
Summaryfalse
Citation.citedArtifact.classification.whoClassified.publisher
Element IdCitation.citedArtifact.classification.whoClassified.publisher
Definition

The publisher of the classification, not the publisher of the article or artifact being cited.

Cardinality0..1
TypeReference(Organization)
Summaryfalse
Citation.citedArtifact.classification.whoClassified.classifierCopyright
Element IdCitation.citedArtifact.classification.whoClassified.classifierCopyright
Definition

Rights management statement for the classification.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.classification.whoClassified.freeToShare
Element IdCitation.citedArtifact.classification.whoClassified.freeToShare
Definition

Acceptable to re-use the classification.

Cardinality0..1
Typeboolean
Summaryfalse
Citation.citedArtifact.contributorship
Element IdCitation.citedArtifact.contributorship
Definition

This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements.

Cardinality0..1
Requirements

Need to support individualized and collective attribution of authorship and contributorship to people and groups.

Summaryfalse
Citation.citedArtifact.contributorship.complete
Element IdCitation.citedArtifact.contributorship.complete
Definition

Indicates if the list includes all authors and/or contributors.

Cardinality0..1
Typeboolean
Summaryfalse
Comments

If list is incomplete "et al" can be appended to Contributorship.summary.value for display purposes.

Citation.citedArtifact.contributorship.entry
Element IdCitation.citedArtifact.contributorship.entry
Definition

An individual entity named in the author list or contributor list.

Cardinality0..*
Summaryfalse
Comments

Used to report contributorship in individualized ways.

Citation.citedArtifact.contributorship.entry.name
Element IdCitation.citedArtifact.contributorship.entry.name
Definition

A name associated with the individual.

Cardinality0..1
TypeHumanName
Summaryfalse
Comments

humanName.family can match MEDLINE-based lastName (used for surname or single name), humanName.given can match MEDLINE-based forename (used for remainder of name except for suffix), humanName.suffix can match MEDLINE-based suffix (eg 2nd, 3rd, Jr, Sr).

Citation.citedArtifact.contributorship.entry.initials
Element IdCitation.citedArtifact.contributorship.entry.initials
Definition

Initials for forename.

Cardinality0..1
Typestring
Summaryfalse
Comments

This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype.

Citation.citedArtifact.contributorship.entry.collectiveName
Element IdCitation.citedArtifact.contributorship.entry.collectiveName
Definition

Used for collective or corporate name as an author.

Cardinality0..1
Typestring
Summaryfalse
Comments

This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype.

Citation.citedArtifact.contributorship.entry.identifier
Element IdCitation.citedArtifact.contributorship.entry.identifier
Definition

Unique person identifier.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
Comments

Avoids needing to disambiguate common last names or changes of name. ORCID is commonly used as author identifier.

Citation.citedArtifact.contributorship.entry.affiliationInfo
Element IdCitation.citedArtifact.contributorship.entry.affiliationInfo
Definition

Organization affiliated with the entity.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.contributorship.entry.affiliationInfo.affiliation
Element IdCitation.citedArtifact.contributorship.entry.affiliationInfo.affiliation
Definition

Display for the organization.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.contributorship.entry.affiliationInfo.role
Element IdCitation.citedArtifact.contributorship.entry.affiliationInfo.role
Definition

Role within the organization, such as professional title.

Cardinality0..1
Typestring
Summaryfalse
Citation.citedArtifact.contributorship.entry.affiliationInfo.identifier
Element IdCitation.citedArtifact.contributorship.entry.affiliationInfo.identifier
Definition

Identifier for the organization.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summaryfalse
Citation.citedArtifact.contributorship.entry.address
Element IdCitation.citedArtifact.contributorship.entry.address
Definition

Physical mailing address for the author or contributor.

Cardinality0..*
TypeAddress
Summaryfalse
Citation.citedArtifact.contributorship.entry.telecom
Element IdCitation.citedArtifact.contributorship.entry.telecom
Definition

Email or telephone contact methods for the author or contributor.

Cardinality0..*
TypeContactPoint
Summaryfalse
Citation.citedArtifact.contributorship.entry.contributionType
Element IdCitation.citedArtifact.contributorship.entry.contributionType
Definition

This element identifies the specific nature of an individual’s contribution with respect to the cited work.

Cardinality0..*
Terminology BindingArtifactContributionType (Extensible)
TypeCodeableConcept
Summaryfalse
Comments

The CreDiT taxonomy provides a way to encode contribution information inside article XML files. The purpose of CRediT is to provide transparency in contributions to scholarly published work, to enable improved systems of attribution, credit, and accountability.

Citation.citedArtifact.contributorship.entry.role
Element IdCitation.citedArtifact.contributorship.entry.role
Definition

The role of the contributor (e.g. author, editor, reviewer).

Cardinality0..1
Terminology BindingContributorRole (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.entry.contributionInstance
Element IdCitation.citedArtifact.contributorship.entry.contributionInstance
Definition

Contributions with accounting for time or number.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.contributorship.entry.contributionInstance.type
Element IdCitation.citedArtifact.contributorship.entry.contributionInstance.type
Definition

The specific contribution.

Cardinality1..1
Terminology BindingArtifactContributionInstanceType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.entry.contributionInstance.time
Element IdCitation.citedArtifact.contributorship.entry.contributionInstance.time
Definition

The time that the contribution was made.

Cardinality0..1
TypedateTime
Summaryfalse
Citation.citedArtifact.contributorship.entry.correspondingContact
Element IdCitation.citedArtifact.contributorship.entry.correspondingContact
Definition

Indication of which contributor is the corresponding contributor for the role.

Cardinality0..1
Typeboolean
Summaryfalse
Citation.citedArtifact.contributorship.entry.rankingOrder
Element IdCitation.citedArtifact.contributorship.entry.rankingOrder
Definition

Provides a numerical ranking to represent the degree of contributorship relative to other contributors, such as 1 for first author and 2 for second author.

Cardinality0..1
TypepositiveInt
Summaryfalse
Citation.citedArtifact.contributorship.summary
Element IdCitation.citedArtifact.contributorship.summary
Definition

Used to record a display of the author/contributor list without separate coding for each list member.

Cardinality0..*
Summaryfalse
Citation.citedArtifact.contributorship.summary.type
Element IdCitation.citedArtifact.contributorship.summary.type
Definition

Used most commonly to express an author list or a contributorship statement.

Cardinality0..1
Terminology BindingContributorSummaryType (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.summary.style
Element IdCitation.citedArtifact.contributorship.summary.style
Definition

The format for the display string.

Cardinality0..1
Terminology BindingContributorSummaryStyle (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.summary.source
Element IdCitation.citedArtifact.contributorship.summary.source
Definition

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

Cardinality0..1
Terminology BindingContributorSummarySource (Extensible)
TypeCodeableConcept
Summaryfalse
Citation.citedArtifact.contributorship.summary.value
Element IdCitation.citedArtifact.contributorship.summary.value
Definition

The display string for the author list, contributor list, or contributorship statement.

Cardinality1..1
Typemarkdown
Summaryfalse
Citation.citedArtifact.note
Element IdCitation.citedArtifact.note
Definition

Any additional information or content for the article or artifact.

Cardinality0..*
TypeAnnotation
Summaryfalse