@POJOBoilerplate
class ImplementationGuide(val id: Option[String], val url: UriStr, val meta: Option[Meta], val text: Option[Narrative], val name: String, val date: Option[FHIRDateTime], val title: Option[String], val status: PUBLICATION_STATUS, val version: Option[String], val contact: LitSeq[ContactDetail], val license: Option[SPDX_LICENSE], val language: Option[LANGUAGES], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val packageId: Id, val useContext: LitSeq[UsageContext], val description: Option[Markdown], val fhirVersion: NonEmptyLitSeq[FHIR_VERSION], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val modifierExtension: LitSeq[Extension], val global: LitSeq[Global], val dependsOn: LitSeq[DependsOn], val manifest: Option[Manifest], val definition: Option[Definition], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource
A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)
- Value parameters:
- contact
- Contact details to assist a user in finding and communicating with the publisher.
- contained
- These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
- copyright
- A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
- date
- The date (and optionally time) when the implementation guide 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 implementation guide changes.
- definition
- The information needed by an IG publisher tool to publish the whole implementation guide.
- dependsOn
- Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
- description
- A free text natural language description of the implementation guide from a consumer's perspective.
- experimental
- A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
- extension
- May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
- fhirVersion
- The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.
- global
- A set of profiles that all resources covered by this implementation guide must conform to.
- id
- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- implicitRules
- A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
- jurisdiction
- A legal or geographic region in which the implementation guide is intended to be used.
- language
- The base language in which the resource is written.
- license
- The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.
- manifest
- Information about an assembled implementation guide, created by the publication tooling.
- meta
- The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- modifierExtension
- May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- name
- A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- packageId
- The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
- publisher
- The name of the organization or individual that published the implementation guide.
- status
- The status of this implementation guide. Enables tracking the life-cycle of the content.
- text
- A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
- title
- A short, descriptive, user-friendly title for the implementation guide.
- url
- An absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.
- useContext
- 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 implementation guide instances.
- version
- The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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.
- Constructor:
Introduces the fields url, name, date, title, status, version, contact, license, publisher, copyright, packageId, useContext, description, fhirVersion, experimental, jurisdiction, global, dependsOn, manifest, definition.
- Companion:
- object
class DomainResource
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any
Value members
Inherited methods
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
Tshould not be a Choice[_], a LitSeq[_] or an Option[_]- It may require a type parameter sometimes (e.g.
sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET })
- Inherited from:
- FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[ImplementationGuide]
- Inherited from:
- FHIRObject
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
- Inherited from:
- FHIRObject
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
- Inherited from:
- Utils
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
- Inherited from:
- Utils
def modifyField[T : LTag, Up >: ImplementationGuide <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
- Inherited from:
- FHIRObject
def modifyFieldUnsafe[T, Up >: ImplementationGuide <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
- Inherited from:
- FHIRObject
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
- Inherited from:
- FHIRObject
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
- Inherited from:
- FHIRObject
Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:
Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:
Tshould not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
- Inherited from:
- FHIRObject
def setFromField[T, UpType >: ImplementationGuide <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
- Inherited from:
- FHIRObject
def updateFromField[T, UpType >: ImplementationGuide <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
- Inherited from:
- FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): ImplementationGuide
- Inherited from:
- FHIRObject
def withField[T : LTag, Up >: ImplementationGuide <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
- Inherited from:
- FHIRObject
def withFieldUnsafe[T, Up >: ImplementationGuide <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
- Inherited from:
- FHIRObject
def withFields[Up >: ImplementationGuide <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
- Inherited from:
- FHIRObject