This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the Citation resource.
Citation | |||||||||
Element Id | Citation | ||||||||
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. | ||||||||
Cardinality | 0..* | ||||||||
Type | MetadataResource | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
Citation.url | |||||||||
Element Id | Citation.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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Requirements | Allows the citation to be referenced by a single globally unique identifier. | ||||||||
Summary | true | ||||||||
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 Id | Citation.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. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable identifiers to be associated with this citation. | ||||||||
Summary | true | ||||||||
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 Id | Citation.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. | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
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 Id | Citation.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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Support human navigation and code generation. | ||||||||
Summary | true | ||||||||
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 |
| ||||||||
Citation.title | |||||||||
Element Id | Citation.title | ||||||||
Definition | A short, descriptive, user-friendly title for the citation. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
Citation.status | |||||||||
Element Id | Citation.status | ||||||||
Definition | The status of this summary. Enables tracking the life-cycle of the content. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||
Type | code | ||||||||
Is Modifier | true (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. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of summarys s that are appropriate for use versus not. | ||||||||
Citation.experimental | |||||||||
Element Id | Citation.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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level citation. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of citations that are appropriate for use versus not. | ||||||||
Citation.date | |||||||||
Element Id | Citation.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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Alternate Names | Revision Date | ||||||||
Summary | true | ||||||||
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 Id | Citation.publisher | ||||||||
Definition | The name of the organization or individual that published the citation. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the citation. May also allow for contact. | ||||||||
Summary | true | ||||||||
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 Id | Citation.contact | ||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||
Citation.description | |||||||||
Element Id | Citation.description | ||||||||
Definition | A free text natural language description of the citation from a consumer's perspective. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
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 Id | Citation.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. | ||||||||
Cardinality | 0..* | ||||||||
Type | UsageContext | ||||||||
Requirements | Assist in searching for appropriate content. | ||||||||
Summary | true | ||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
Citation.jurisdiction | |||||||||
Element Id | Citation.jurisdiction | ||||||||
Definition | A legal or geographic region in which the citation is intended to be used. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Jurisdiction (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
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 Id | Citation.purpose | ||||||||
Definition | Explanation of why this citation is needed and why it has been designed as it has. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
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 Id | Citation.copyright | ||||||||
Definition | Use and/or publishing restrictions for the Citation, not for the cited artifact. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Citation.approvalDate | |||||||||
Element Id | Citation.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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Summary | false | ||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||
Citation.lastReviewDate | |||||||||
Element Id | Citation.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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
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. | ||||||||
Summary | false | ||||||||
Comments | If specified, this date follows the original approval date. | ||||||||
Citation.effectivePeriod | |||||||||
Element Id | Citation.effectivePeriod | ||||||||
Definition | The period during which the citation content was or is planned to be in active use. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Period | ||||||||
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. | ||||||||
Summary | true | ||||||||
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 Id | Citation.author | ||||||||
Definition | Who authored the Citation. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
Citation.editor | |||||||||
Element Id | Citation.editor | ||||||||
Definition | Who edited the Citation. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
Citation.reviewer | |||||||||
Element Id | Citation.reviewer | ||||||||
Definition | Who reviewed the Citation. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
Citation.endorser | |||||||||
Element Id | Citation.endorser | ||||||||
Definition | Who endorsed the Citation. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
Citation.summary | |||||||||
Element Id | Citation.summary | ||||||||
Definition | A human-readable display of the citation. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
Citation.summary.style | |||||||||
Element Id | Citation.summary.style | ||||||||
Definition | Format for display of the citation. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | CitationSummaryStyle (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.summary.text | |||||||||
Element Id | Citation.summary.text | ||||||||
Definition | The human-readable display of the citation. | ||||||||
Cardinality | 1..1 | ||||||||
Type | markdown | ||||||||
Summary | true | ||||||||
Citation.classification | |||||||||
Element Id | Citation.classification | ||||||||
Definition | The assignment to an organizing scheme. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.classification.type | |||||||||
Element Id | Citation.classification.type | ||||||||
Definition | The kind of classifier (e.g. publication type, keyword). | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | CitationClassificationType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.classification.classifier | |||||||||
Element Id | Citation.classification.classifier | ||||||||
Definition | The specific classification value. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | CitationArtifactClassifier (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.note | |||||||||
Element Id | Citation.note | ||||||||
Definition | Used for general notes and annotations not coded elsewhere. | ||||||||
Cardinality | 0..* | ||||||||
Type | Annotation | ||||||||
Summary | false | ||||||||
Citation.currentState | |||||||||
Element Id | Citation.currentState | ||||||||
Definition | The status of the citation. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | CitationStatusType (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.statusDate | |||||||||
Element Id | Citation.statusDate | ||||||||
Definition | An effective date or period for a status of the citation. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.statusDate.activity | |||||||||
Element Id | Citation.statusDate.activity | ||||||||
Definition | Classification of the status. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | CitationStatusType (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.statusDate.actual | |||||||||
Element Id | Citation.statusDate.actual | ||||||||
Definition | Either occurred or expected. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
Citation.statusDate.period | |||||||||
Element Id | Citation.statusDate.period | ||||||||
Definition | When the status started and/or ended. | ||||||||
Cardinality | 1..1 | ||||||||
Type | Period | ||||||||
Summary | false | ||||||||
Comments | For an instance, place the same value in both start and end elements. | ||||||||
Citation.relatesTo | |||||||||
Element Id | Citation.relatesTo | ||||||||
Definition | Artifact related to the Citation Resource. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.relatesTo.relationshipType | |||||||||
Element Id | Citation.relatesTo.relationshipType | ||||||||
Definition | How the Citation resource relates to the target artifact. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | ArtifactRelationshipType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.relatesTo.targetClassifier | |||||||||
Element Id | Citation.relatesTo.targetClassifier | ||||||||
Definition | The clasification of the related artifact. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | CitationArtifactClassifier (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.relatesTo.target[x] | |||||||||
Element Id | Citation.relatesTo.target[x] | ||||||||
Definition | The article or artifact that the Citation Resource is related to. | ||||||||
Cardinality | 1..1 | ||||||||
Type | uri|Identifier|Reference(Any)|Attachment | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Summary | false | ||||||||
Citation.citedArtifact | |||||||||
Element Id | Citation.citedArtifact | ||||||||
Definition | The article or artifact being described. | ||||||||
Cardinality | 0..1 | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.identifier | |||||||||
Element Id | Citation.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. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable identifiers to be associated with this citation. | ||||||||
Summary | true | ||||||||
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 Id | Citation.citedArtifact.relatedIdentifier | ||||||||
Definition | A formal identifier that is used to identify things closely related to this citation. | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable identifiers to be associated with this citation. | ||||||||
Summary | true | ||||||||
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 Id | Citation.citedArtifact.dateAccessed | ||||||||
Definition | When the cited artifact was accessed. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Summary | true | ||||||||
Citation.citedArtifact.version | |||||||||
Element Id | Citation.citedArtifact.version | ||||||||
Definition | The defined version of the cited artifact. | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.version.value | |||||||||
Element Id | Citation.citedArtifact.version.value | ||||||||
Definition | The version number or other version identifier. | ||||||||
Cardinality | 1..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.version.baseCitation | |||||||||
Element Id | Citation.citedArtifact.version.baseCitation | ||||||||
Definition | Citation for the main version of the cited artifact. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Citation) | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.currentState | |||||||||
Element Id | Citation.citedArtifact.currentState | ||||||||
Definition | The status of the cited artifact. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | CitedArtifactStatusType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.statusDate | |||||||||
Element Id | Citation.citedArtifact.statusDate | ||||||||
Definition | An effective date or period for a status of the cited artifact. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.statusDate.activity | |||||||||
Element Id | Citation.citedArtifact.statusDate.activity | ||||||||
Definition | Classification of the status. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | CitedArtifactStatusType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.statusDate.actual | |||||||||
Element Id | Citation.citedArtifact.statusDate.actual | ||||||||
Definition | Either occurred or expected. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.statusDate.period | |||||||||
Element Id | Citation.citedArtifact.statusDate.period | ||||||||
Definition | When the status started and/or ended. | ||||||||
Cardinality | 1..1 | ||||||||
Type | Period | ||||||||
Summary | false | ||||||||
Comments | For an instance, place the same value in both start and end elements. | ||||||||
Citation.citedArtifact.title | |||||||||
Element Id | Citation.citedArtifact.title | ||||||||
Definition | The title details of the article or artifact. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.title.type | |||||||||
Element Id | Citation.citedArtifact.title.type | ||||||||
Definition | Used to express the reason or specific aspect for the title. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | TitleType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.title.language | |||||||||
Element Id | Citation.citedArtifact.title.language | ||||||||
Definition | Used to express the specific language. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Common Languages (Preferred) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.title.text | |||||||||
Element Id | Citation.citedArtifact.title.text | ||||||||
Definition | The title of the article or artifact. | ||||||||
Cardinality | 1..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.abstract | |||||||||
Element Id | Citation.citedArtifact.abstract | ||||||||
Definition | Summary of the article or artifact. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.abstract.type | |||||||||
Element Id | Citation.citedArtifact.abstract.type | ||||||||
Definition | Used to express the reason or specific aspect for the abstract. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | CitedArtifactAbstractType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.abstract.language | |||||||||
Element Id | Citation.citedArtifact.abstract.language | ||||||||
Definition | Used to express the specific language. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Common Languages (Preferred) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.abstract.text | |||||||||
Element Id | Citation.citedArtifact.abstract.text | ||||||||
Definition | Abstract content. | ||||||||
Cardinality | 1..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.abstract.copyright | |||||||||
Element Id | Citation.citedArtifact.abstract.copyright | ||||||||
Definition | Copyright notice for the abstract. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.part | |||||||||
Element Id | Citation.citedArtifact.part | ||||||||
Definition | The component of the article or artifact. | ||||||||
Cardinality | 0..1 | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.part.type | |||||||||
Element Id | Citation.citedArtifact.part.type | ||||||||
Definition | The kind of component. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | CitedArtifactPartType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.part.value | |||||||||
Element Id | Citation.citedArtifact.part.value | ||||||||
Definition | The specification of the component. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.part.baseCitation | |||||||||
Element Id | Citation.citedArtifact.part.baseCitation | ||||||||
Definition | The citation for the full article or artifact. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Citation) | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.relatesTo | |||||||||
Element Id | Citation.citedArtifact.relatesTo | ||||||||
Definition | The artifact related to the cited artifact. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.relatesTo.relationshipType | |||||||||
Element Id | Citation.citedArtifact.relatesTo.relationshipType | ||||||||
Definition | How the cited artifact resource relates to the target artifact. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | ArtifactRelationshipType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.relatesTo.targetClassifier | |||||||||
Element Id | Citation.citedArtifact.relatesTo.targetClassifier | ||||||||
Definition | The clasification of the related artifact. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | CitationArtifactClassifier (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.relatesTo.target[x] | |||||||||
Element Id | Citation.citedArtifact.relatesTo.target[x] | ||||||||
Definition | The article or artifact that the cited artifact is related to. | ||||||||
Cardinality | 1..1 | ||||||||
Type | uri|Identifier|Reference(Any)|Attachment | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm | |||||||||
Element Id | Citation.citedArtifact.publicationForm | ||||||||
Definition | If multiple, used to represent alternative forms of the article that are not separate citations. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
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 Id | Citation.citedArtifact.publicationForm.publishedIn | ||||||||
Definition | The collection the cited article or artifact is published in. | ||||||||
Cardinality | 0..1 | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.publishedIn.type | |||||||||
Element Id | Citation.citedArtifact.publicationForm.publishedIn.type | ||||||||
Definition | Kind of container (e.g. Periodical, database, or book). | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | PublishedInType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Comments | Journals and newspapers are coded as Periodical. | ||||||||
Citation.citedArtifact.publicationForm.publishedIn.identifier | |||||||||
Element Id | Citation.citedArtifact.publicationForm.publishedIn.identifier | ||||||||
Definition | Journal identifiers include ISSN, ISO Abbreviation and NLMuniqueID; Book identifiers include ISBN. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.publishedIn.title | |||||||||
Element Id | Citation.citedArtifact.publicationForm.publishedIn.title | ||||||||
Definition | Name of the database or title of the book or journal. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Comments | ClinicalTrials.gov is a name of a database. | ||||||||
Citation.citedArtifact.publicationForm.publishedIn.publisher | |||||||||
Element Id | Citation.citedArtifact.publicationForm.publishedIn.publisher | ||||||||
Definition | Name of the publisher. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Organization) | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.publishedIn.publisherLocation | |||||||||
Element Id | Citation.citedArtifact.publicationForm.publishedIn.publisherLocation | ||||||||
Definition | Geographic location of the publisher. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease | ||||||||
Definition | The specific issue in which the cited article resides. | ||||||||
Cardinality | 0..1 | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.citedMedium | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.citedMedium | ||||||||
Definition | Describes the form of the medium cited. Common codes are "Internet" or "Print". | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | JournalIssueMedium (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Comments | National Library of Medicine uses the codes "Internet" or "Print". | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.volume | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.volume | ||||||||
Definition | Volume number of journal in which the article is published. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.issue | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.issue | ||||||||
Definition | Issue, part or supplement of journal in which the article is published. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication | ||||||||
Definition | Defining the date on which the issue of the journal was published. | ||||||||
Cardinality | 0..1 | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.date | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.date | ||||||||
Definition | Date on which the issue of the journal was published. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.year | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.year | ||||||||
Definition | Year on which the issue of the journal was published. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.month | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.month | ||||||||
Definition | Month on which the issue of the journal was published. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.day | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.day | ||||||||
Definition | Day on which the issue of the journal was published. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.season | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.season | ||||||||
Definition | Spring, Summer, Fall/Autumn, Winter. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.text | |||||||||
Element Id | Citation.citedArtifact.publicationForm.periodicRelease.dateOfPublication.text | ||||||||
Definition | Text representation of the date of which the issue of the journal was published. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.articleDate | |||||||||
Element Id | Citation.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). | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.lastRevisionDate | |||||||||
Element Id | Citation.citedArtifact.publicationForm.lastRevisionDate | ||||||||
Definition | The date the article was last revised or updated in the database. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.language | |||||||||
Element Id | Citation.citedArtifact.publicationForm.language | ||||||||
Definition | Language in which this form of the article is published. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Common Languages (Preferred) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
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 Id | Citation.citedArtifact.publicationForm.accessionNumber | ||||||||
Definition | Entry number or identifier for inclusion in a database. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.pageString | |||||||||
Element Id | Citation.citedArtifact.publicationForm.pageString | ||||||||
Definition | Used for full display of pagination. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.firstPage | |||||||||
Element Id | Citation.citedArtifact.publicationForm.firstPage | ||||||||
Definition | Used for isolated representation of first page. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.lastPage | |||||||||
Element Id | Citation.citedArtifact.publicationForm.lastPage | ||||||||
Definition | Used for isolated representation of last page. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.pageCount | |||||||||
Element Id | Citation.citedArtifact.publicationForm.pageCount | ||||||||
Definition | Actual or approximate number of pages or screens. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.publicationForm.copyright | |||||||||
Element Id | Citation.citedArtifact.publicationForm.copyright | ||||||||
Definition | Copyright notice for the full article or artifact. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.webLocation | |||||||||
Element Id | Citation.citedArtifact.webLocation | ||||||||
Definition | Used for any URL for the article or artifact cited. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.webLocation.type | |||||||||
Element Id | Citation.citedArtifact.webLocation.type | ||||||||
Definition | Code the reason for different URLs, e.g. abstract and full-text. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ArticleUrlType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.webLocation.url | |||||||||
Element Id | Citation.citedArtifact.webLocation.url | ||||||||
Definition | The specific URL. | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Summary | false | ||||||||
Comments | Persistent URLs, like doi, are preferred. | ||||||||
Citation.citedArtifact.classification | |||||||||
Element Id | Citation.citedArtifact.classification | ||||||||
Definition | The assignment to an organizing scheme. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.type | |||||||||
Element Id | Citation.citedArtifact.classification.type | ||||||||
Definition | The kind of classifier (e.g. publication type, keyword). | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | CitedArtifactClassificationType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.classifier | |||||||||
Element Id | Citation.citedArtifact.classification.classifier | ||||||||
Definition | The specific classification value. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | CitationArtifactClassifier (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.whoClassified | |||||||||
Element Id | Citation.citedArtifact.classification.whoClassified | ||||||||
Definition | Provenance and copyright of classification. | ||||||||
Cardinality | 0..1 | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.whoClassified.person | |||||||||
Element Id | Citation.citedArtifact.classification.whoClassified.person | ||||||||
Definition | Person who created the classification. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Person | Practitioner) | ||||||||
Patterns | Reference(Person,Practitioner): No common pattern | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.whoClassified.organization | |||||||||
Element Id | Citation.citedArtifact.classification.whoClassified.organization | ||||||||
Definition | Organization who created the classification. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Organization) | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.whoClassified.publisher | |||||||||
Element Id | Citation.citedArtifact.classification.whoClassified.publisher | ||||||||
Definition | The publisher of the classification, not the publisher of the article or artifact being cited. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Organization) | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.whoClassified.classifierCopyright | |||||||||
Element Id | Citation.citedArtifact.classification.whoClassified.classifierCopyright | ||||||||
Definition | Rights management statement for the classification. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.classification.whoClassified.freeToShare | |||||||||
Element Id | Citation.citedArtifact.classification.whoClassified.freeToShare | ||||||||
Definition | Acceptable to re-use the classification. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship | |||||||||
Element Id | Citation.citedArtifact.contributorship | ||||||||
Definition | This element is used to list authors and other contributors, their contact information, specific contributions, and summary statements. | ||||||||
Cardinality | 0..1 | ||||||||
Requirements | Need to support individualized and collective attribution of authorship and contributorship to people and groups. | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.complete | |||||||||
Element Id | Citation.citedArtifact.contributorship.complete | ||||||||
Definition | Indicates if the list includes all authors and/or contributors. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
Comments | If list is incomplete "et al" can be appended to Contributorship.summary.value for display purposes. | ||||||||
Citation.citedArtifact.contributorship.entry | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry | ||||||||
Definition | An individual entity named in the author list or contributor list. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Comments | Used to report contributorship in individualized ways. | ||||||||
Citation.citedArtifact.contributorship.entry.name | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.name | ||||||||
Definition | A name associated with the individual. | ||||||||
Cardinality | 0..1 | ||||||||
Type | HumanName | ||||||||
Summary | false | ||||||||
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 Id | Citation.citedArtifact.contributorship.entry.initials | ||||||||
Definition | Initials for forename. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Comments | This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype. | ||||||||
Citation.citedArtifact.contributorship.entry.collectiveName | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.collectiveName | ||||||||
Definition | Used for collective or corporate name as an author. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Comments | This element is used in Medline based citations, but not supported fully by FHIR HumanName datatype. | ||||||||
Citation.citedArtifact.contributorship.entry.identifier | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.identifier | ||||||||
Definition | Unique person identifier. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Summary | false | ||||||||
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 Id | Citation.citedArtifact.contributorship.entry.affiliationInfo | ||||||||
Definition | Organization affiliated with the entity. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.affiliationInfo.affiliation | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.affiliationInfo.affiliation | ||||||||
Definition | Display for the organization. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.affiliationInfo.role | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.affiliationInfo.role | ||||||||
Definition | Role within the organization, such as professional title. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.affiliationInfo.identifier | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.affiliationInfo.identifier | ||||||||
Definition | Identifier for the organization. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.address | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.address | ||||||||
Definition | Physical mailing address for the author or contributor. | ||||||||
Cardinality | 0..* | ||||||||
Type | Address | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.telecom | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.telecom | ||||||||
Definition | Email or telephone contact methods for the author or contributor. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactPoint | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.contributionType | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.contributionType | ||||||||
Definition | This element identifies the specific nature of an individual’s contribution with respect to the cited work. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | ArtifactContributionType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
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 Id | Citation.citedArtifact.contributorship.entry.role | ||||||||
Definition | The role of the contributor (e.g. author, editor, reviewer). | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ContributorRole (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.contributionInstance | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.contributionInstance | ||||||||
Definition | Contributions with accounting for time or number. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.contributionInstance.type | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.contributionInstance.type | ||||||||
Definition | The specific contribution. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | ArtifactContributionInstanceType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.contributionInstance.time | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.contributionInstance.time | ||||||||
Definition | The time that the contribution was made. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.correspondingContact | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.correspondingContact | ||||||||
Definition | Indication of which contributor is the corresponding contributor for the role. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.entry.listOrder | |||||||||
Element Id | Citation.citedArtifact.contributorship.entry.listOrder | ||||||||
Definition | Used to code order of authors. | ||||||||
Cardinality | 0..1 | ||||||||
Type | positiveInt | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.summary | |||||||||
Element Id | Citation.citedArtifact.contributorship.summary | ||||||||
Definition | Used to record a display of the author/contributor list without separate coding for each list member. | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.summary.type | |||||||||
Element Id | Citation.citedArtifact.contributorship.summary.type | ||||||||
Definition | Used most commonly to express an author list or a contributorship statement. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ContributorSummaryType (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.summary.style | |||||||||
Element Id | Citation.citedArtifact.contributorship.summary.style | ||||||||
Definition | The format for the display string. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ContributorSummaryStyle (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.summary.source | |||||||||
Element Id | Citation.citedArtifact.contributorship.summary.source | ||||||||
Definition | Used to code the producer or rule for creating the display string. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ContributorSummarySource (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.contributorship.summary.value | |||||||||
Element Id | Citation.citedArtifact.contributorship.summary.value | ||||||||
Definition | The display string for the author list, contributor list, or contributorship statement. | ||||||||
Cardinality | 1..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Citation.citedArtifact.note | |||||||||
Element Id | Citation.citedArtifact.note | ||||||||
Definition | Any additional information or content for the article or artifact. | ||||||||
Cardinality | 0..* | ||||||||
Type | Annotation | ||||||||
Summary | false |