Private OptionalidentifierCatalogEntry.identifier Element
Private Optionaltype_CatalogEntry.type Element
PrivateorderableCatalogEntry.orderable Element
PrivatereferencedCatalogEntry.referencedItem Element
FHIR Specification
Reference
Private OptionaladditionalCatalogEntry.additionalIdentifier Element
Private OptionalclassificationCatalogEntry.classification Element
Private ReadonlypublicationFHIR CodeSystem: PublicationStatus
Private OptionalstatusCatalogEntry.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalvalidityCatalogEntry.validityPeriod Element
Private OptionalvalidCatalogEntry.validTo Element
Private OptionallastCatalogEntry.lastUpdated Element
FHIR Specification
dateTimePrivate OptionaladditionalCatalogEntry.additionalCharacteristic Element
Private OptionaladditionalCatalogEntry.additionalClassification Element
Private OptionalrelatedCatalogEntry.relatedEntry Element
StaticparseParse the provided CatalogEntry JSON to instantiate the CatalogEntry data model.
JSON representing FHIR CatalogEntry
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CatalogEntry
CatalogEntry data model or undefined for CatalogEntry
JsonError if the provided JSON is not a valid JSON object
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 type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Type object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the orderable property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the orderable property.
the orderable value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the orderable property exists and has a value; false otherwise
the orderable property value as a fhirBoolean if defined; else null
Assigns the provided primitive value to the orderable property.
the orderable value
this
PrimitiveTypeError for invalid primitive types
true if the orderable property exists and has a value; false otherwise
the referencedItem property value as a Reference object if defined; else an empty Reference object
Assigns the provided ReferencedItem object value to the referencedItem property.
the referencedItem object value
this
@ReferenceTargets('CatalogEntry.referencedItem', ['Medication','Device','Organization','Practitioner','PractitionerRole','HealthcareService','ActivityDefinition','PlanDefinition','SpecimenDefinition','ObservationDefinition','Binary',])
InvalidTypeError for invalid data type or reference value
true if the referencedItem property exists and has a value; false otherwise
the additionalIdentifier property value as a Identifier array
Assigns the provided Identifier array value to the additionalIdentifier property.
the additionalIdentifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the additionalIdentifier array property.
the additionalIdentifier value
this
InvalidTypeError for invalid data types
true if the additionalIdentifier property exists and has a value; false otherwise
the classification property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the classification property.
the classification array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept 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 status property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code values
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 undefined
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 undefined
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 validityPeriod property value as a Period object if defined; else an empty Period object
Assigns the provided ValidityPeriod object value to the validityPeriod property.
the validityPeriod object value
this
InvalidTypeError for invalid data types
true if the validityPeriod property exists and has a value; false otherwise
the validTo property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the validTo property.
the validTo value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the validTo property exists and has a value; false otherwise
the validTo property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the validTo property.
the validTo value
this
PrimitiveTypeError for invalid primitive types
true if the validTo property exists and has a value; false otherwise
the lastUpdated property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the lastUpdated property.
the lastUpdated value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the lastUpdated property exists and has a value; false otherwise
the lastUpdated property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the lastUpdated property.
the lastUpdated value
this
PrimitiveTypeError for invalid primitive types
true if the lastUpdated property exists and has a value; false otherwise
the additionalCharacteristic property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the additionalCharacteristic property.
the additionalCharacteristic array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the additionalCharacteristic array property.
the additionalCharacteristic value
this
InvalidTypeError for invalid data types
true if the additionalCharacteristic property exists and has a value; false otherwise
the additionalClassification property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the additionalClassification property.
the additionalClassification array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the additionalClassification array property.
the additionalClassification value
this
InvalidTypeError for invalid data types
true if the additionalClassification property exists and has a value; false otherwise
the relatedEntry property value as a CatalogEntryRelatedEntryComponent array
Assigns the provided CatalogEntryRelatedEntryComponent array value to the relatedEntry property.
the relatedEntry array value
this
InvalidTypeError for invalid data types
Add the provided CatalogEntryRelatedEntryComponent value to the relatedEntry array property.
the relatedEntry value
this
InvalidTypeError for invalid data types
true if the relatedEntry 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 additionalIdentifier property
PrivateinitInitialize the classification property
PrivateinitInitialize the additionalCharacteristic property
PrivateinitInitialize the additionalClassification property
PrivateinitInitialize the relatedEntry property
CatalogEntry Class
Remarks
Catalog entries are wrappers that contextualize items included in a catalog.
FHIR Specification
See
FHIR CatalogEntry