IG TTP-FHIR Gateway

ConsentPolicy

ActivityDefinition	I		ActivityDefinition	Element Id ActivityDefinition Short description Consent Policy Definition Atomare Aussage zu der eine Person seine Einwilligung erteilen kann Data Type ActivityDefinition Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` adf-0:Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` Mappings rim:Entity. Role, or Act workflow:Definition rim:Act[classCode=ACT; moodCode=DEFN]
meta	S Σ	1..1	Meta	There are no (further) constraints on this element Element Id ActivityDefinition.meta Short description Metadata about the resource Definition 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. Data Type Meta Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
versionId	Σ	0..1	id	There are no (further) constraints on this element Element Id ActivityDefinition.meta.versionId Short description Version specific identifier Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. Data Type id Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
lastUpdated	S Σ	1..1	instant	Element Id ActivityDefinition.meta.lastUpdated Short description updateDate Definition When the resource last changed - e.g. when the version changed. Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
source	Σ	0..1	uri	There are no (further) constraints on this element Element Id ActivityDefinition.meta.source Short description Identifies where the resource comes from Definition A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile	Σ	0..*	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id ActivityDefinition.meta.profile Short description Profiles this resource claims to conform to Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
security	Σ	0..*	CodingBinding	There are no (further) constraints on this element Element Id ActivityDefinition.meta.security Short description Security Labels applied to this resource Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. Comments The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Data Type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding
tag	Σ	0..*	Coding	There are no (further) constraints on this element Element Id ActivityDefinition.meta.tag Short description Tags applied to this resource Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Data Type Coding Binding Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding
extension	I	0..*	Extension	There are no (further) constraints on this element Element Id ActivityDefinition.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
created	S I	0..1	Extension(instant)	Element Id ActivityDefinition.extension:created Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(instant) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/Created Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
externalProperty	S I	0..*	Extension(Complex)	Element Id ActivityDefinition.extension:externalProperty Short description externalProperties Alternate names extensions, user content Definition Liste frei konfigurierbarer external Properties nach dem KeyValuePrinzip zur Auswertung durch externe Anwendersysteme Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension(Complex) Extension URL https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
extension	I	2..*	Extension	There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
key	I	1..1	Extension	There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.extension:key Short description External Property Key Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.extension:key.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value key Mappings rim:N/A
value[x]	S	1..1		There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.extension:key.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueString			string	There are no (further) constraints on this element Data Type string
value	I	1..1	Extension	There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.extension:value Short description External Property Value Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.extension:value.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value value Mappings rim:N/A
value[x]	S	1..1		There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.extension:value.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueString			string	There are no (further) constraints on this element Data Type string
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id ActivityDefinition.extension:externalProperty.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
url	Σ	0..0	uri	There are no (further) constraints on this element Element Id ActivityDefinition.url Short description Canonical identifier for this activity definition, represented as a URI (globally unique) Definition 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. Requirements Allows the activity definition to be referenced by a single globally unique identifier. 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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.url w5:FiveWs.identifier rim:.identifier[scope=BUSN;reliability=ISS]
identifier	Σ	0..0	Identifier	There are no (further) constraints on this element Element Id ActivityDefinition.identifier Short description Additional identifier for the activity definition Definition 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. Requirements Allows externally provided and/or usable business identifiers to be easily associated with the module. Comments Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier workflow:Definition.identifier w5:FiveWs.identifier rim:.identifier objimpl:no-gen-base
version	S Σ	1..1	string	Element Id ActivityDefinition.version Short description version Definition 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. Comments There may be different activity definition 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 activity definition with the format [url]\|[version]. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.version w5:FiveWs.version rim:N/A (to add?)
name	S Σ I	1..1	string	Element Id ActivityDefinition.name Short description name Definition Name der ConsentPolicy (computer friendly) Requirements Support human navigation and code generation. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
title	S Σ	0..1	string	Element Id ActivityDefinition.title Short description label Definition Bezeichnung (human friendly) Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.title rim:.title
subtitle		0..0	string	There are no (further) constraints on this element Element Id ActivityDefinition.subtitle Short description Subordinate title of the activity definition Definition An explanatory or alternate title for the activity definition giving additional information about its content. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
status	S Σ ?!	1..1	codeBinding	Element Id ActivityDefinition.status Short description finalisiert ja/nein Definition Bearbeitungsstatus: gICS-Äquivalente: finalized=true => active finalized=false => draft Comments Allows filtering of activity definitions that are appropriate for use versus not. Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.status {different ValueSet} w5:FiveWs.status rim:.status
experimental	Σ	0..0	boolean	There are no (further) constraints on this element Element Id ActivityDefinition.experimental Short description For testing purposes, not real usage Definition 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. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition. Comments Allows filtering of activity definitions that are appropriate for use versus not. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.experimental w5:FiveWs.class rim:N/A (to add?)
subject[x]		0..0	Binding	There are no (further) constraints on this element Element Id ActivityDefinition.subject[x] Short description Type of individual the activity definition is intended for Definition A code or group definition that describes the intended subject of the activity being defined. Binding The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.). SubjectType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.subject
date	Σ	0..0	dateTime	There are no (further) constraints on this element Element Id ActivityDefinition.date Short description Date last changed Alternate names Revision Date Definition 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. Comments Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.date w5:FiveWs.recorded rim:.participation[typeCode=AUT].time
publisher	Σ	0..0	string	There are no (further) constraints on this element Element Id ActivityDefinition.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the activity definition. Requirements Helps establish the "authority/credibility" of the activity definition. May also allow for contact. Comments Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. 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 activity definition. This item SHOULD be populated unless the information is available from context. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.publisher {as string instead of CodeableConcept} w5:FiveWs.witness rim:.participation[typeCode=AUT].role
contact	Σ	0..0	ContactDetail	There are no (further) constraints on this element Element Id ActivityDefinition.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.contact rim:.participation[typeCode=CALLBCK].role
description	S Σ	0..1	markdown	Element Id ActivityDefinition.description Short description comment Definition administrative comment Comments This description can be used to capture details such as why the activity definition 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 activity definition 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 activity definition is presumed to be the predominant language in the place the activity definition was created). Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.description rim:.text
useContext	S Σ	1..1	UsageContext	Element Id ActivityDefinition.useContext Short description domainName Definition Verweis auf die Domain Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data Type UsageContext Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.useContext rim:N/A (to add?)
code	S Σ	1..1	CodingBinding	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.code Short description Type of context being specified Definition A code that identifies the type of context being specified by this usage context. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data Type Coding Binding A code that specifies a type of context being specified by a usage context. UsageContextType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding
system	S Σ	1..1	uriFixed Value	Element Id ActivityDefinition.useContext.code.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value http://terminology.hl7.org/CodeSystem/usage-context-type Mappings rim:n/a v2:CE.3 rim:./codeSystem orim:*fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.code.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.7 rim:./codeSystemVersion orim:*fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	1..1	codeFixed Value	Element Id ActivityDefinition.useContext.code.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value program Mappings rim:n/a v2:CE.1 rim:./code orim:*fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.code.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.2 - but note this is not well followed rim:CV.displayName orim:*fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.code.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:Sometimes implied by being first rim:CD.codingRationale orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
value[x]	S Σ	1..1		There are no (further) constraints on this element Element Id ActivityDefinition.useContext.value[x] Short description Value that defines the context Definition A value that defines the context specified in this context of use. The interpretation of the value is defined by the code. Binding A code that defines the specific value for the context being specified. Context of Use ValueSet (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
reference	S Σ I	1..1	string	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.value[x].reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.value[x].type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.value[x].identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
display	Σ	0..1	string	There are no (further) constraints on this element Element Id ActivityDefinition.useContext.value[x].display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueReference			Reference(Consent Domain)	Data Type Reference(Consent Domain)
jurisdiction	Σ	0..0	CodeableConceptBinding	There are no (further) constraints on this element Element Id ActivityDefinition.jurisdiction Short description Intended jurisdiction for activity definition (if applicable) Definition A legal or geographic region in which the activity definition is intended to be used. Comments It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended. Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Definition.jurisdiction rim:N/A (to add?)
purpose		0..0	markdown	There are no (further) constraints on this element Element Id ActivityDefinition.purpose Short description Why this activity definition is defined Definition Explanation of why this activity definition is needed and why it has been designed as it has. Comments This element does not describe the usage of the activity definition. 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 activity definition. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.purpose w5:FiveWs.why[x] rim:.reasonCode.text objimpl:no-gen-base
usage		0..0	string	Element Id ActivityDefinition.usage Short description comment Definition administrative comment Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A (to add?)
copyright		0..0	markdown	There are no (further) constraints on this element Element Id ActivityDefinition.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition 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. Requirements Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.copyright rim:N/A (to add?) objimpl:no-gen-base
approvalDate		0..0	date	There are no (further) constraints on this element Element Id ActivityDefinition.approvalDate Short description When the activity definition was approved by publisher Definition The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. Comments The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.approvalDate rim:.outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime objimpl:no-gen-base
lastReviewDate		0..0	date	There are no (further) constraints on this element Element Id ActivityDefinition.lastReviewDate Short description When the activity definition was last reviewed Definition The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval 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. Comments If specified, this date follows the original approval date. Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.lastReviewDate rim:.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime objimpl:no-gen-base
effectivePeriod	Σ I	0..0	Period	There are no (further) constraints on this element Element Id ActivityDefinition.effectivePeriod Short description When the activity definition is expected to be used Definition The period during which the activity definition content was or is planned to be in active use. Requirements Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead. Comments The effective period for a activity definition 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. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] workflow:Definition.effectivePeriod rim:N/A (to add?) objimpl:no-gen-base
topic		0..0	CodeableConcept	There are no (further) constraints on this element Element Id ActivityDefinition.topic Short description E.g. Education, Treatment, Assessment, etc. Definition 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. Requirements Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding High-level categorization of the definition, used for searching, sorting, and filtering. DefinitionTopic (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:N/A (to add?)
author		0..0	ContactDetail	There are no (further) constraints on this element Element Id ActivityDefinition.author Short description Who authored the content Definition An individiual or organization primarily involved in the creation and maintenance of the content. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.participation[typeCode=AUT]
editor		0..0	ContactDetail	There are no (further) constraints on this element Element Id ActivityDefinition.editor Short description Who edited the content Definition An individual or organization primarily responsible for internal coherence of the content. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
reviewer		0..0	ContactDetail	There are no (further) constraints on this element Element Id ActivityDefinition.reviewer Short description Who reviewed the content Definition An individual or organization primarily responsible for review of some aspect of the content. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}
endorser		0..0	ContactDetail	There are no (further) constraints on this element Element Id ActivityDefinition.endorser Short description Who endorsed the content Definition An individual or organization responsible for officially endorsing the content for use in some setting. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}
relatedArtifact		0..0	RelatedArtifact	There are no (further) constraints on this element Element Id ActivityDefinition.relatedArtifact Short description Additional documentation, citations, etc. Definition Related artifacts such as additional documentation, justification, or bibliographic references. Requirements Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. Comments Each related artifact is either an attachment, or a reference to another resource, but not both. Data Type RelatedArtifact Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}
library		0..0	canonical(Library)	There are no (further) constraints on this element Element Id ActivityDefinition.library Short description Logic used by the activity definition Definition A reference to a Library resource containing any formal logic used by the activity definition. Comments see Canonical References Data Type canonical(Library) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.outboundRelationship[typeCode=USE].target[classCode=GROUPER,moodCode=EVN]
kind	Σ	0..0	codeBinding	There are no (further) constraints on this element Element Id ActivityDefinition.kind Short description Kind of resource Definition 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. Comments May determine what types of extensions are permitted. Data Type code Binding The kind of activity the definition is describing. RequestResourceType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.classCode
profile		0..0	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id ActivityDefinition.profile Short description What profile the resource needs to conform to Definition A profile to which the target of the activity definition is expected to conform. Requirements Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set. Comments see Canonical References Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
code	S Σ	1..1	CodeableConceptBinding	Element Id ActivityDefinition.code Short description Detail type of activity Definition Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. Requirements Allows matching performed to planned as well as validation against protocols. Comments Tends to be less relevant for activities involving particular products. Data Type CodeableConcept Binding Detailed type of the activity; e.g. CBC. Policy (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.code
coding	S Σ	1..*	Coding	There are no (further) constraints on this element Element Id ActivityDefinition.code.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for alternative encodings within a code system, and translations to other code systems. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data Type Coding Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding v2:CE.1-8, CE.10-22 rim:union(., ./translation) orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
system	S Σ	1..1	uri	There are no (further) constraints on this element Element Id ActivityDefinition.code.coding.system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. Requirements Need to be unambiguous about the source of the definition of the symbol. Comments The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.3 rim:./codeSystem orim:*fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element Id ActivityDefinition.code.coding.version Short description Version of the system - if relevant Definition The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Comments Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.7 rim:./codeSystemVersion orim:*fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	1..1	code	There are no (further) constraints on this element Element Id ActivityDefinition.code.coding.code Short description Symbol in syntax defined by the system Definition A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.1 rim:./code orim:*fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	0..1	string	There are no (further) constraints on this element Element Id ActivityDefinition.code.coding.display Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.2 - but note this is not well followed rim:CV.displayName orim:*fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element Id ActivityDefinition.code.coding.userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). Requirements This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Comments Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:Sometimes implied by being first rim:CD.codingRationale orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text	Σ	0..1	string	There are no (further) constraints on this element Element Id ActivityDefinition.code.text Short description Plain text representation of the concept Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.9. But note many systems use CE.2 for this rim:./originalText[mediaType/code="text/plain"]/data orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
intent		0..0	codeBinding	There are no (further) constraints on this element Element Id ActivityDefinition.intent Short description proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Definition Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Codes indicating the degree of authority/intentionality associated with a request. RequestIntent (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
priority		0..0	codeBinding	There are no (further) constraints on this element Element Id ActivityDefinition.priority Short description routine \| urgent \| asap \| stat Definition Indicates how quickly the activity should be addressed with respect to other requests. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Identifies the level of importance to be assigned to actioning the request. RequestPriority (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
doNotPerform	Σ ?!	0..0	boolean	There are no (further) constraints on this element Element Id ActivityDefinition.doNotPerform Short description True if the activity should not be performed Definition 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. Comments This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestGroup. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
timing[x]		0..0		There are no (further) constraints on this element Element Id ActivityDefinition.timing[x] Short description When activity is to occur Definition The period, timing or frequency upon which the described activity is to occur. Requirements Allows prompting for activities and detection of missed planned activities. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
location	I	0..0	Reference(Location)	There are no (further) constraints on this element Element Id ActivityDefinition.location Short description Where it should happen Alternate names facility Definition Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. Requirements Helps in planning of activity. Comments May reference a specific clinical location or may just identify a type of location. Data Type Reference(Location) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.participation[typeCode=LOC].role
participant		0..0	BackboneElement	There are no (further) constraints on this element Element Id ActivityDefinition.participant Short description Who should participate in the action Definition Indicates who should participate in performing the action described. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.participation[typeCode=PFM]
product[x]		0..0		There are no (further) constraints on this element Element Id ActivityDefinition.product[x] Short description What's administered/supplied Definition Identifies the food, drug or other product being consumed or supplied in the activity. Binding Code describing the type of substance or medication. SNOMEDCTMedicationCodes (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.participation[typeCode=CSM].role
quantity	I	0..0	SimpleQuantity	There are no (further) constraints on this element Element Id ActivityDefinition.quantity Short description How much is administered/consumed/supplied Alternate names dose Definition Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). Comments The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. Data Type SimpleQuantity Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` qty-3:If a code for the unit is present, the system SHALL also be present `code.empty() or system.exists()` sqty-1:The comparator is not used on a SimpleQuantity `comparator.empty()` Mappings rim:n/a v2:SN (see also Range) or CQ rim:PQ, IVL<PQ>, MO, CO, depending on the values rim:.quantity {for classCode=SPLY}
dosage		0..0	Dosage	There are no (further) constraints on this element Element Id ActivityDefinition.dosage Short description Detailed dosage instructions Definition Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. Comments If a dosage instruction is used, the definition should not specify timing or quantity. Data Type Dosage Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:.outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT] rim:.outboundRelationship[typeCode=COMP].target[classCode=SBADM; moodCode=DEFN]
bodySite		0..0	CodeableConcept	There are no (further) constraints on this element Element Id ActivityDefinition.bodySite Short description What part of body to perform on Definition Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). Requirements Knowing where the procedure is made is important for tracking if multiple sites are possible. Comments Only used if not implicit in the code found in ServiceRequest.type. Data Type CodeableConcept Binding A code that identifies the anatomical location. SNOMEDCTBodyStructures (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD rim:.targetSiteCode {for classCode=PROC, SBADM}
specimenRequirement	I	0..0	Reference(SpecimenDefinition)	There are no (further) constraints on this element Element Id ActivityDefinition.specimenRequirement Short description What specimens are required to perform this action Definition Defines specimen requirements for the action to be performed, such as required specimens for a lab test. Requirements Needed to represent lab order definitions. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(SpecimenDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
observationRequirement	I	0..0	Reference(ObservationDefinition)	There are no (further) constraints on this element Element Id ActivityDefinition.observationRequirement Short description What observations are required to perform this action Definition Defines observation requirements for the action to be performed, such as body weight or surface area. Requirements Needed to represent observation definitions. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(ObservationDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
observationResultRequirement	I	0..0	Reference(ObservationDefinition)	There are no (further) constraints on this element Element Id ActivityDefinition.observationResultRequirement Short description What observations must be produced by this action Definition Defines the observations that are expected to be produced by the action. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(ObservationDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
transform		0..0	canonical(StructureMap)	There are no (further) constraints on this element Element Id ActivityDefinition.transform Short description Transform to apply the template Definition 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. Comments Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. Data Type canonical(StructureMap) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
dynamicValue		0..0	BackboneElement	There are no (further) constraints on this element Element Id ActivityDefinition.dynamicValue Short description Dynamic aspects of the definition Definition 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. Comments Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A

Zweck

Abbildung aller relevanten Information zur Verwaltung wiederverwendbarer Einwilligungspolicies mit gICS

Suchparameter

Name	Typ	Beschreibung	Pfad
useContextIdentifier	token	Eindeutiger Name (Identifikator) der Domain	ActivityDefinition.useContext.valueReference(ResearchStudy).identifier
name	string	Name der Policy	ActivityDefinition.name
code	token	Code der Policy	ActivityDefinition.code
version	token	Version der Policy	ActivityDefinition.version

Zulässige Kombinationen von Suchparametern:

alle Policies einer Consent Domain
GET [base]/gics/ActivityDefinition?useContextIdentifier=MIRACUM
spezifische Policy einer Consent Domain nach Name
GET [base]/gics/ActivityDefinition?useContextIdentifier=MIRACUM&name=BIOMAT_Analysedaten_erheben&version=1.0
spezifische Policy einer Consent Domain nach Code
GET [base]/gics/ActivityDefinition?useContextIdentifier=MIRACUM&code=https://ths-greifswald.de/fhir/CodeSystem/gics/Policy|MDAT_speichern&version=1.0

Beispiel

<ActivityDefinition xmlns="http://hl7.org/fhir">
    <id value="ConsentPolicy-example-1" />
    <meta>
        <lastUpdated value="2020-11-04T19:13:38.269+00:00" />
        <profile value="https://ths-greifswald.de/fhir/StructureDefinition/gics/ActivityDefinition/ConsentPolicy" />
    </meta>
    <extension url="https://ths-greifswald.de/fhir/StructureDefinition/gics/Created">
        <valueInstant value="2020-01-02T04:05:06+01:00" />
    </extension>
    <extension url="https://ths-greifswald.de/fhir/StructureDefinition/gics/ExternalProperty">
        <extension url="key">
            <valueString value="semantic_code" />
        </extension>
        <extension url="value">
            <valueString value="12345" />
        </extension>
    </extension>
    <version value="1.0" />
    <name value="MDAT_erheben" />
    <title value="Medizinische Daten erheben" />
    <status value="active" />
    <description value="Beispiel Consent Policy f&#252;r die Erhebung medizinischer Daten im Rahmen eines Forschungsprojektes" />
    <useContext>
        <code>
            <system value="http://terminology.hl7.org/CodeSystem/usage-context-type" />
            <code value="program" />
        </code>
        <valueReference>
            <reference value="d7a65ce8-2810-401a-b0db-70782a7b19a6" />
        </valueReference>
    </useContext>
    <code>
        <coding>
            <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" />
            <code value="MDAT_erheben" />
        </coding>
    </code>
</ActivityDefinition>