ActivityDefinitionCreateInput
No description
input ActivityDefinitionCreateInput {
url: Uri
identifier: [IdentifierCreateInput!]
version: String
name: String
title: String
subtitle: String
status: String!
experimental: Boolean
subjectCodeableConcept: CodeableConceptCreateInput
subjectReference: ReferenceCreateInput
subjectCanonical: Uri
date: Date
publisher: String
contact: [ContactDetailCreateInput!]
description: String
useContext: [UsageContextCreateInput!]
jurisdiction: [CodeableConceptCreateInput!]
purpose: String
usage: String
copyright: String
approvalDate: Date
lastReviewDate: Date
effectivePeriod: PeriodCreateInput
topic: [CodeableConceptCreateInput!]
author: [ContactDetailCreateInput!]
editor: [ContactDetailCreateInput!]
reviewer: [ContactDetailCreateInput!]
endorser: [ContactDetailCreateInput!]
relatedArtifact: [RelatedArtifactCreateInput!]
library: [Uri!]
kind: String
profile: Uri
code: CodeableConceptCreateInput
intent: String
priority: String
doNotPerform: Boolean
timingTiming: TimingCreateInput
timingDateTime: Date
timingAge: AgeCreateInput
timingPeriod: PeriodCreateInput
timingRange: RangeCreateInput
timingDuration: FhirDurationCreateInput
location: ReferenceCreateInput
participant: [ActivityDefinitionParticipantCreateInput!]
productReference: ReferenceCreateInput
productCodeableConcept: CodeableConceptCreateInput
quantity: QuantityCreateInput
dosage: [DosageCreateInput!]
bodySite: [CodeableConceptCreateInput!]
specimenRequirement: [ReferenceCreateInput!]
observationRequirement: [ReferenceCreateInput!]
observationResultRequirement: [ReferenceCreateInput!]
transform: Uri
dynamicValue: [ActivityDefinitionDynamicValueCreateInput!]
text: NarrativeCreateInput
contained: [ResourceCreateInput!]
extension: [FhirExtensionCreateInput!]
modifierExtension: [FhirExtensionCreateInput!]
id: String
meta: FhirMetaCreateInput
implicitRules: Uri
language: String
}
Fields
ActivityDefinitionCreateInput.url ● Uri scalar
An absolute URI that is used to identify this activity definition 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 activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
ActivityDefinitionCreateInput.identifier ● [IdentifierCreateInput!] list input
A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
ActivityDefinitionCreateInput.version ● String scalar
The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
ActivityDefinitionCreateInput.name ● String scalar
A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
ActivityDefinitionCreateInput.title ● String scalar
A short, descriptive, user-friendly title for the activity definition.
ActivityDefinitionCreateInput.subtitle ● String scalar
An explanatory or alternate title for the activity definition giving additional information about its content.
ActivityDefinitionCreateInput.status ● String! non-null scalar
The status of this activity definition. Enables tracking the life-cycle of the content.
ActivityDefinitionCreateInput.experimental ● Boolean scalar
A Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
ActivityDefinitionCreateInput.subjectCodeableConcept ● CodeableConceptCreateInput input
A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)
ActivityDefinitionCreateInput.subjectReference ● ReferenceCreateInput input
A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)
ActivityDefinitionCreateInput.subjectCanonical ● Uri scalar
A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. (choose any one of subject*, but only one)
ActivityDefinitionCreateInput.date ● Date scalar
The date (and optionally time) when the activity definition 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 activity definition changes.
ActivityDefinitionCreateInput.publisher ● String scalar
The name of the organization or individual that published the activity definition.
ActivityDefinitionCreateInput.contact ● [ContactDetailCreateInput!] list input
Contact details to assist a user in finding and communicating with the publisher.
ActivityDefinitionCreateInput.description ● String scalar
A free text natural language description of the activity definition from a consumer s perspective.
ActivityDefinitionCreateInput.useContext ● [UsageContextCreateInput!] list input
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 activity definition instances.
ActivityDefinitionCreateInput.jurisdiction ● [CodeableConceptCreateInput!] list input
A legal or geographic region in which the activity definition is intended to be used.
ActivityDefinitionCreateInput.purpose ● String scalar
Explanation of why this activity definition is needed and why it has been designed as it has.
ActivityDefinitionCreateInput.usage ● String scalar
A detailed description of how the activity definition is used from a clinical perspective.
ActivityDefinitionCreateInput.copyright ● String scalar
A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
ActivityDefinitionCreateInput.approvalDate ● Date scalar
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
ActivityDefinitionCreateInput.lastReviewDate ● Date scalar
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
ActivityDefinitionCreateInput.effectivePeriod ● PeriodCreateInput input
The period during which the activity definition content was or is planned to be in active use.
ActivityDefinitionCreateInput.topic ● [CodeableConceptCreateInput!] list input
Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
ActivityDefinitionCreateInput.author ● [ContactDetailCreateInput!] list input
An individiual or organization primarily involved in the creation and maintenance of the content.
ActivityDefinitionCreateInput.editor ● [ContactDetailCreateInput!] list input
An individual or organization primarily responsible for internal coherence of the content.
ActivityDefinitionCreateInput.reviewer ● [ContactDetailCreateInput!] list input
An individual or organization primarily responsible for review of some aspect of the content.
ActivityDefinitionCreateInput.endorser ● [ContactDetailCreateInput!] list input
An individual or organization responsible for officially endorsing the content for use in some setting.
ActivityDefinitionCreateInput.relatedArtifact ● [RelatedArtifactCreateInput!] list input
Related artifacts such as additional documentation, justification, or bibliographic references.
ActivityDefinitionCreateInput.library ● [Uri!] list scalar
A reference to a Library resource containing any formal logic used by the activity definition.
ActivityDefinitionCreateInput.kind ● String scalar
A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
ActivityDefinitionCreateInput.profile ● Uri scalar
A profile to which the target of the activity definition is expected to conform.
ActivityDefinitionCreateInput.code ● CodeableConceptCreateInput input
Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
ActivityDefinitionCreateInput.intent ● String scalar
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
ActivityDefinitionCreateInput.priority ● String scalar
Indicates how quickly the activity should be addressed with respect to other requests.
ActivityDefinitionCreateInput.doNotPerform ● Boolean scalar
Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
ActivityDefinitionCreateInput.timingTiming ● TimingCreateInput input
The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)
ActivityDefinitionCreateInput.timingDateTime ● Date scalar
The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)
ActivityDefinitionCreateInput.timingAge ● AgeCreateInput input
The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)
ActivityDefinitionCreateInput.timingPeriod ● PeriodCreateInput input
The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)
ActivityDefinitionCreateInput.timingRange ● RangeCreateInput input
The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)
ActivityDefinitionCreateInput.timingDuration ● FhirDurationCreateInput input
The period, timing or frequency upon which the described activity is to occur. (choose any one of timing*, but only one)
ActivityDefinitionCreateInput.location ● ReferenceCreateInput input
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
ActivityDefinitionCreateInput.participant ● [ActivityDefinitionParticipantCreateInput!] list input
Indicates who should participate in performing the action described.
ActivityDefinitionCreateInput.productReference ● ReferenceCreateInput input
Identifies the food, drug or other product being consumed or supplied in the activity. (choose any one of product*, but only one)
ActivityDefinitionCreateInput.productCodeableConcept ● CodeableConceptCreateInput input
Identifies the food, drug or other product being consumed or supplied in the activity. (choose any one of product*, but only one)
ActivityDefinitionCreateInput.quantity ● QuantityCreateInput input
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
ActivityDefinitionCreateInput.dosage ● [DosageCreateInput!] list input
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
ActivityDefinitionCreateInput.bodySite ● [CodeableConceptCreateInput!] list input
Indicates the sites on the subject s body where the procedure should be performed (I.e. the target sites).
ActivityDefinitionCreateInput.specimenRequirement ● [ReferenceCreateInput!] list input
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
ActivityDefinitionCreateInput.observationRequirement ● [ReferenceCreateInput!] list input
Defines observation requirements for the action to be performed, such as body weight or surface area.
ActivityDefinitionCreateInput.observationResultRequirement ● [ReferenceCreateInput!] list input
Defines the observations that are expected to be produced by the action.
ActivityDefinitionCreateInput.transform ● Uri scalar
A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
ActivityDefinitionCreateInput.dynamicValue ● [ActivityDefinitionDynamicValueCreateInput!] list input
Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient s weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
ActivityDefinitionCreateInput.text ● NarrativeCreateInput input
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.
ActivityDefinitionCreateInput.contained ● [ResourceCreateInput!] list input
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.
ActivityDefinitionCreateInput.extension ● [FhirExtensionCreateInput!] list input
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.
ActivityDefinitionCreateInput.modifierExtension ● [FhirExtensionCreateInput!] list input
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).
ActivityDefinitionCreateInput.id ● String scalar
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ActivityDefinitionCreateInput.meta ● FhirMetaCreateInput input
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.
ActivityDefinitionCreateInput.implicitRules ● Uri scalar
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.
ActivityDefinitionCreateInput.language ● String scalar
The base language in which the resource is written.
Member Of
ActivityDefinitionCreate mutation