Private OptionalurlCitation.url Element
FHIR Specification
uriPrivate OptionalidentifierCitation.identifier Element
FHIR Specification
IdentifierPrivate OptionalversionCitation.version Element
FHIR Specification
stringPrivate OptionalversionCitation.versionAlgorithm[x] Element
FHIR Specification
Private OptionalnameCitation.name Element
FHIR Specification
stringPrivate OptionaltitleCitation.title Element
FHIR Specification
stringPrivate ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusCitation.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalexperimentalCitation.experimental Element
FHIR Specification
booleanPrivate OptionaldateCitation.date Element
FHIR Specification
dateTimePrivate OptionalpublisherCitation.publisher Element
FHIR Specification
stringPrivate OptionalcontactCitation.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionCitation.description Element
FHIR Specification
markdownPrivate OptionaluseCitation.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionCitation.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposeCitation.purpose Element
FHIR Specification
markdownPrivate OptionalcopyrightCitation.copyright Element
Private OptionalcopyrightCitation.copyrightLabel Element
FHIR Specification
stringPrivate OptionalapprovalCitation.approvalDate Element
FHIR Specification
datePrivate OptionallastCitation.lastReviewDate Element
FHIR Specification
datePrivate OptionaleffectiveCitation.effectivePeriod Element
FHIR Specification
PeriodPrivate OptionalauthorCitation.author Element
FHIR Specification
ContactDetailPrivate OptionaleditorCitation.editor Element
FHIR Specification
ContactDetailPrivate OptionalreviewerCitation.reviewer Element
FHIR Specification
ContactDetailPrivate OptionalendorserCitation.endorser Element
FHIR Specification
ContactDetailPrivate OptionalsummaryCitation.summary Element
Private OptionalclassificationCitation.classification Element
FHIR Specification
BackboneElementPrivate OptionalnoteCitation.note Element
Private OptionalcurrentCitation.currentState Element
FHIR Specification
CodeableConceptPrivate OptionalstatusCitation.statusDate Element
FHIR Specification
BackboneElementPrivate OptionalrelatedCitation.relatedArtifact Element
FHIR Specification
RelatedArtifactPrivate OptionalcitedCitation.citedArtifact Element
StaticparseParse the provided Citation JSON to instantiate the Citation data model.
JSON representing FHIR Citation
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Citation
Citation data model or undefined for Citation
JsonError if the provided JSON is not a valid JSON object
the url property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the version property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the version property.
the version value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the version property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the version property.
the version value
this
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the versionAlgorithm property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the versionAlgorithm property.
the versionAlgorithm object value
this
InvalidTypeError for invalid data types
true if the versionAlgorithm property exists and has a value; false otherwise
the versionAlgorithm property value as a StringType object if defined; else undefined
true if the versionAlgorithm property exists as a StringType and has a value; false otherwise
the versionAlgorithm property value as a Coding object if defined; else undefined
true if the versionAlgorithm property exists as a Coding and has a value; false otherwise
the name property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the name property.
the name value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the name property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the name property.
the name value
this
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the title property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the title property.
the title value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the title property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the title property.
the title value
this
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the experimental property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the experimental property.
the experimental value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the experimental property exists and has a value; false otherwise
the experimental property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the experimental property.
the experimental value
this
PrimitiveTypeError for invalid primitive types
true if the experimental property exists and has a value; false otherwise
the date property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the date property.
the date value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the date property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the date property.
the date value
this
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the publisher property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the publisher property.
the publisher value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the publisher property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the publisher property.
the publisher value
this
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the contact property value as a ContactDetail array
Assigns the provided ContactDetail array value to the contact property.
the contact array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the contact array property.
the contact value
this
InvalidTypeError for invalid data types
true if the contact property exists and has a value; false otherwise
the description property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the useContext property value as a UsageContext array
Assigns the provided UsageContext array value to the useContext property.
the useContext array value
this
InvalidTypeError for invalid data types
Add the provided UsageContext value to the useContext array property.
the useContext value
this
InvalidTypeError for invalid data types
true if the useContext property exists and has a value; false otherwise
the jurisdiction property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the jurisdiction property.
the jurisdiction array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the jurisdiction array property.
the jurisdiction value
this
InvalidTypeError for invalid data types
true if the jurisdiction property exists and has a value; false otherwise
the purpose property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the purpose property.
the purpose value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the purpose property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the purpose property.
the purpose value
this
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the copyright property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the copyright property.
the copyright value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the copyright property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the copyright property.
the copyright value
this
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the copyrightLabel property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the copyrightLabel property.
the copyrightLabel value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the copyrightLabel property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the copyrightLabel property.
the copyrightLabel value
this
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the approvalDate property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the approvalDate property.
the approvalDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the approvalDate property exists and has a value; false otherwise
the approvalDate property value as a fhirDate if defined; else undefined
Assigns the provided primitive value to the approvalDate property.
the approvalDate value
this
PrimitiveTypeError for invalid primitive types
true if the approvalDate property exists and has a value; false otherwise
the lastReviewDate property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the lastReviewDate property.
the lastReviewDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the lastReviewDate property exists and has a value; false otherwise
the lastReviewDate property value as a fhirDate if defined; else undefined
Assigns the provided primitive value to the lastReviewDate property.
the lastReviewDate value
this
PrimitiveTypeError for invalid primitive types
true if the lastReviewDate property exists and has a value; false otherwise
the effectivePeriod property value as a Period object if defined; else an empty Period object
Assigns the provided EffectivePeriod object value to the effectivePeriod property.
the effectivePeriod object value
this
InvalidTypeError for invalid data types
true if the effectivePeriod property exists and has a value; false otherwise
the author property value as a ContactDetail array
Assigns the provided ContactDetail array value to the author property.
the author array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the author array property.
the author value
this
InvalidTypeError for invalid data types
true if the author property exists and has a value; false otherwise
the editor property value as a ContactDetail array
Assigns the provided ContactDetail array value to the editor property.
the editor array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the editor array property.
the editor value
this
InvalidTypeError for invalid data types
true if the editor property exists and has a value; false otherwise
the reviewer property value as a ContactDetail array
Assigns the provided ContactDetail array value to the reviewer property.
the reviewer array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the reviewer array property.
the reviewer value
this
InvalidTypeError for invalid data types
true if the reviewer property exists and has a value; false otherwise
the endorser property value as a ContactDetail array
Assigns the provided ContactDetail array value to the endorser property.
the endorser array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the endorser array property.
the endorser value
this
InvalidTypeError for invalid data types
true if the endorser property exists and has a value; false otherwise
the summary property value as a CitationSummaryComponent array
Assigns the provided CitationSummaryComponent array value to the summary property.
the summary array value
this
InvalidTypeError for invalid data types
Add the provided CitationSummaryComponent value to the summary array property.
the summary value
this
InvalidTypeError for invalid data types
true if the summary property exists and has a value; false otherwise
the classification property value as a CitationClassificationComponent array
Assigns the provided CitationClassificationComponent array value to the classification property.
the classification array value
this
InvalidTypeError for invalid data types
Add the provided CitationClassificationComponent value to the classification array property.
the classification value
this
InvalidTypeError for invalid data types
true if the classification property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the currentState property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the currentState property.
the currentState array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the currentState array property.
the currentState value
this
InvalidTypeError for invalid data types
true if the currentState property exists and has a value; false otherwise
the statusDate property value as a CitationStatusDateComponent array
Assigns the provided CitationStatusDateComponent array value to the statusDate property.
the statusDate array value
this
InvalidTypeError for invalid data types
Add the provided CitationStatusDateComponent value to the statusDate array property.
the statusDate value
this
InvalidTypeError for invalid data types
true if the statusDate property exists and has a value; false otherwise
the relatedArtifact property value as a RelatedArtifact array
Assigns the provided RelatedArtifact array value to the relatedArtifact property.
the relatedArtifact array value
this
InvalidTypeError for invalid data types
Add the provided RelatedArtifact value to the relatedArtifact array property.
the relatedArtifact value
this
InvalidTypeError for invalid data types
true if the relatedArtifact property exists and has a value; false otherwise
the citedArtifact property value as a CitationCitedArtifactComponent object if defined; else an empty CitationCitedArtifactComponent object
Assigns the provided CitedArtifact object value to the citedArtifact property.
the citedArtifact object value
this
InvalidTypeError for invalid data types
true if the citedArtifact property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the contact property
PrivateinitInitialize the useContext property
PrivateinitInitialize the jurisdiction property
PrivateinitInitialize the author property
PrivateinitInitialize the editor property
PrivateinitInitialize the reviewer property
PrivateinitInitialize the endorser property
PrivateinitInitialize the summary property
PrivateinitInitialize the classification property
PrivateinitInitialize the note property
PrivateinitInitialize the currentState property
PrivateinitInitialize the statusDate property
PrivateinitInitialize the relatedArtifact property
Citation Class
Remarks
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.
FHIR Specification
See
FHIR Citation