{ "resourceType": "StructureDefinition", "id": "GraphDefinition", "meta": { "lastUpdated": "2017-04-18T21:44:43.294+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"GraphDefinitionDomainResourceDefinition of an graph of resources\r\n
Elements defined in Ancestors: \r\n id, \r\n meta, \r\n implicitRules, \r\n language, \r\n text, \r\n contained, \r\n extension, \r\n modifierExtension
\".\"\".\"\".\"urlΣ0..1uriLogical URI to reference this graph definition (globally unique)
\".\"\".\"\".\"versionΣ0..1stringBusiness version of the graph definition
\".\"\".\"\".\"nameΣ1..1stringName for this graph definition (computer friendly)
\".\"\".\"\".\"status?!Σ1..1codedraft | active | retired | unknown\r\n
PublicationStatus (\r\n Required)\r\n
\".\"\".\"\".\"experimental?!Σ0..1booleanFor testing purposes, not real usage
\".\"\".\"\".\"dateΣ0..1dateTimeDate this was last changed
\".\"\".\"\".\"publisherΣ0..1stringName of the publisher (organization or individual)
\".\"\".\"\".\"contactΣ0..*ContactDetailContact details for the publisher\r\n
\".\"\".\"\".\"description0..1markdownNatural language description of the graph definition
\".\"\".\"\".\"useContextΣ0..*UsageContextContext the content is intended to support\r\n
\".\"\".\"\".\"jurisdictionΣ0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)\r\n
Jurisdiction ValueSet (\r\n Extensible)\r\n
\".\"\".\"\".\"purpose0..1markdownWhy this graph definition is defined
\".\"\".\"\".\"start1..1codeType of resource at which the graph starts\r\n
ResourceType (\r\n Required)\r\n
\".\"\".\"\".\"profile0..1uriProfile on base resource
\".\"\".\"\".\"link0..*BackboneElementLinks this graph makes rules about\r\n
\".\"\".\"\".\"\".\"path1..1stringPath in the resource that contains the link
\".\"\".\"\".\"\".\"sliceName0..1stringWhich slice (if profiled)
\".\"\".\"\".\"\".\"min0..1integerMinimum occurrences for this link
\".\"\".\"\".\"\".\"max0..1stringMaximum occurrences for this link
\".\"\".\"\".\"\".\"description0..1stringWhy this link is specified
\".\"\".\"\".\"\".\"target1..*BackboneElementPotential target for the link\r\n
\".\"\".\"\".\"\".\"\".\"type1..1codeType of resource this link refers to\r\n
ResourceType (\r\n Required)\r\n
\".\"\".\"\".\"\".\"\".\"profile0..1uriProfile for the target resource
\".\"\".\"\".\"\".\"\".\"compartment0..*BackboneElementCompartment Consistency Rules\r\n
\".\"\".\"\".\"\".\"\".\"\".\"code1..1codeIdentifies the compartment\r\n
CompartmentType (\r\n Required)\r\n
\".\"\".\"\".\"\".\"\".\"\".\"rule1..1codeidentical | matching | different | custom\r\n
GraphCompartmentRule (\r\n Required)\r\n
\".\"\".\"\".\"\".\"\".\"\".\"expression0..1stringCustom rule, as a FHIRPath expression
\".\"\".\"\".\"\".\"\".\"\".\"description0..1stringDocumentation for FHIRPath expression
\".\"\".\"\".\"\".\"\".\"link0..*see \r\n linkAdditional links from target resource\r\n

\"doco\" Documentation for this format\r\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "fhir" } ], "url": "http://hl7.org/fhir/StructureDefinition/GraphDefinition", "name": "GraphDefinition", "status": "draft", "date": "2017-04-18T21:44:43+00:00", "publisher": "Health Level Seven International (FHIR Infrastructure)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm" } ] } ], "description": "Base StructureDefinition for GraphDefinition Resource", "fhirVersion": "3.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" }, { "identity": "objimpl", "uri": "http://hl7.org/fhir/object-implementation", "name": "Object Implementation Information" } ], "kind": "resource", "abstract": false, "type": "GraphDefinition", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "_baseDefinition": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super", "valueString": "MetadataResource" } ] }, "derivation": "specialization", "snapshot": { "element": [ { "id": "GraphDefinition", "path": "GraphDefinition", "short": "Definition of an graph of resources", "definition": "A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.", "min": 0, "max": "*", "base": { "path": "Resource", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Definition" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "conformance.behavior" } ] }, { "id": "GraphDefinition.id", "path": "GraphDefinition.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "isSummary": true }, { "id": "GraphDefinition.meta", "path": "GraphDefinition.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "id": "GraphDefinition.implicitRules", "path": "GraphDefinition.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "id": "GraphDefinition.language", "path": "GraphDefinition.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } }, { "id": "GraphDefinition.text", "path": "GraphDefinition.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may 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.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "GraphDefinition.contained", "path": "GraphDefinition.contained", "short": "Contained, inline Resources", "definition": "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.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "GraphDefinition.extension", "path": "GraphDefinition.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "GraphDefinition.modifierExtension", "path": "GraphDefinition.modifierExtension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Extensions that cannot be ignored", "definition": "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. Usually modifier elements provide negation or qualification. In order 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "GraphDefinition.url", "path": "GraphDefinition.url", "short": "Logical URI to reference this graph definition (globally unique)", "definition": "An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).", "comment": "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.", "requirements": "Allows the graph definition to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "w5", "map": "id" } ] }, { "id": "GraphDefinition.version", "path": "GraphDefinition.version", "short": "Business version of the graph definition", "definition": "The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph 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.", "comment": "There may be different graph definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the graph definition with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "w5", "map": "id.version" } ] }, { "id": "GraphDefinition.name", "path": "GraphDefinition.name", "short": "Name for this graph definition (computer friendly)", "definition": "A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", "comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" } ] }, { "id": "GraphDefinition.status", "path": "GraphDefinition.status", "short": "draft | active | retired | unknown", "definition": "The status of this graph definition. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of graph definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired graph definition without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PublicationStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The lifecycle status of a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "workflow", "map": "Definition.status (different ValueSet)" }, { "identity": "w5", "map": "status" } ] }, { "id": "GraphDefinition.experimental", "path": "GraphDefinition.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of graph definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental graph definition in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level graph definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "w5", "map": "class" } ] }, { "id": "GraphDefinition.date", "path": "GraphDefinition.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the graph definition was published. The date must change if and 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 graph definition changes.", "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the graph definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.", "alias": [ "Revision Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "GraphDefinition.publisher", "path": "GraphDefinition.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the graph definition.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the graph definition is the organization or individual primarily responsible for the maintenance and upkeep of the graph 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 graph definition. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the graph definition. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher" }, { "identity": "w5", "map": "who.witness" } ] }, { "id": "GraphDefinition.contact", "path": "GraphDefinition.contact", "short": "Contact details for the publisher", "definition": "Contact details to assist a user in finding and communicating with the publisher.", "comment": "May be a web site, an email address, a telephone number, etc.", "min": 0, "max": "*", "type": [ { "code": "ContactDetail" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" } ] }, { "id": "GraphDefinition.description", "path": "GraphDefinition.description", "short": "Natural language description of the graph definition", "definition": "A free text natural language description of the graph definition from a consumer's perspective.", "comment": "This description can be used to capture details such as why the graph 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 graph 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.description" } ] }, { "id": "GraphDefinition.useContext", "path": "GraphDefinition.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" } ] }, { "id": "GraphDefinition.jurisdiction", "path": "GraphDefinition.jurisdiction", "short": "Intended jurisdiction for graph definition (if applicable)", "definition": "A legal or geographic region in which the graph definition is intended to be used.", "comment": "It may be possible for the graph definition to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Jurisdiction" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Countries and regions within which this artifact is targeted for use", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" } ] }, { "id": "GraphDefinition.purpose", "path": "GraphDefinition.purpose", "short": "Why this graph definition is defined", "definition": "Explaination of why this graph definition is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the graph 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 graph definition.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] }, { "id": "GraphDefinition.start", "path": "GraphDefinition.start", "short": "Type of resource at which the graph starts", "definition": "The type of FHIR resource at which instances of this graph start.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } }, { "id": "GraphDefinition.profile", "path": "GraphDefinition.profile", "short": "Profile on base resource", "definition": "The profile that describes the use of the base resource.", "comment": "The code does not include the '$' prefix that is always included in the URL when the operation is invoked.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] }, { "id": "GraphDefinition.link", "path": "GraphDefinition.link", "short": "Links this graph makes rules about", "definition": "Links this graph makes rules about.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] } ] }, "differential": { "element": [ { "id": "GraphDefinition", "path": "GraphDefinition", "short": "Definition of an graph of resources", "definition": "A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.", "min": 0, "max": "*", "mapping": [ { "identity": "workflow", "map": "Definition" }, { "identity": "rim", "map": "n/a" }, { "identity": "w5", "map": "conformance.behavior" } ] }, { "id": "GraphDefinition.url", "path": "GraphDefinition.url", "short": "Logical URI to reference this graph definition (globally unique)", "definition": "An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).", "comment": "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.", "requirements": "Allows the graph definition to be referenced by a single globally unique identifier.", "min": 0, "max": "1", "type": [ { "code": "uri" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.url" }, { "identity": "w5", "map": "id" } ] }, { "id": "GraphDefinition.version", "path": "GraphDefinition.version", "short": "Business version of the graph definition", "definition": "The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph 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.", "comment": "There may be different graph definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the graph definition with the format [url]|[version].", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.version" }, { "identity": "w5", "map": "id.version" } ] }, { "id": "GraphDefinition.name", "path": "GraphDefinition.name", "short": "Name for this graph definition (computer friendly)", "definition": "A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.", "comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.", "requirements": "Support human navigation and code generation.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.title" } ] }, { "id": "GraphDefinition.status", "path": "GraphDefinition.status", "short": "draft | active | retired | unknown", "definition": "The status of this graph definition. Enables tracking the life-cycle of the content.", "comment": "Allows filtering of graph definitions that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired graph definition without due consideration.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PublicationStatus" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The lifecycle status of a Value Set or Concept Map.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/publication-status" } }, "mapping": [ { "identity": "workflow", "map": "Definition.status (different ValueSet)" }, { "identity": "w5", "map": "status" } ] }, { "id": "GraphDefinition.experimental", "path": "GraphDefinition.experimental", "short": "For testing purposes, not real usage", "definition": "A boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.", "comment": "Allows filtering of graph definition that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental graph definition in production.", "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level graph definition.", "min": 0, "max": "1", "type": [ { "code": "boolean" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.experimental" }, { "identity": "w5", "map": "class" } ] }, { "id": "GraphDefinition.date", "path": "GraphDefinition.date", "short": "Date this was last changed", "definition": "The date (and optionally time) when the graph definition was published. The date must change if and 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 graph definition changes.", "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the graph definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.", "alias": [ "Revision Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.date" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "GraphDefinition.publisher", "path": "GraphDefinition.publisher", "short": "Name of the publisher (organization or individual)", "definition": "The name of the individual or organization that published the graph definition.", "comment": "Usually an organization, but may be an individual. The publisher (or steward) of the graph definition is the organization or individual primarily responsible for the maintenance and upkeep of the graph 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 graph definition. This item SHOULD be populated unless the information is available from context.", "requirements": "Helps establish the \"authority/credibility\" of the graph definition. May also allow for contact.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.publisher" }, { "identity": "w5", "map": "who.witness" } ] }, { "id": "GraphDefinition.contact", "path": "GraphDefinition.contact", "short": "Contact details for the publisher", "definition": "Contact details to assist a user in finding and communicating with the publisher.", "comment": "May be a web site, an email address, a telephone number, etc.", "min": 0, "max": "*", "type": [ { "code": "ContactDetail" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.contact" } ] }, { "id": "GraphDefinition.description", "path": "GraphDefinition.description", "short": "Natural language description of the graph definition", "definition": "A free text natural language description of the graph definition from a consumer's perspective.", "comment": "This description can be used to capture details such as why the graph 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 graph 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 profile is presumed to be the predominant language in the place the profile was created).", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.description" } ] }, { "id": "GraphDefinition.useContext", "path": "GraphDefinition.useContext", "short": "Context the content is intended to support", "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.", "comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.", "requirements": "Assist in searching for appropriate content.", "min": 0, "max": "*", "type": [ { "code": "UsageContext" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Definition.useContext" } ] }, { "id": "GraphDefinition.jurisdiction", "path": "GraphDefinition.jurisdiction", "short": "Intended jurisdiction for graph definition (if applicable)", "definition": "A legal or geographic region in which the graph definition is intended to be used.", "comment": "It may be possible for the graph definition to be used in jurisdictions other than those for which it was originally designed or intended.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Jurisdiction" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "Countries and regions within which this artifact is targeted for use", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/jurisdiction" } }, "mapping": [ { "identity": "workflow", "map": "Definition.jurisdiction" } ] }, { "id": "GraphDefinition.purpose", "path": "GraphDefinition.purpose", "short": "Why this graph definition is defined", "definition": "Explaination of why this graph definition is needed and why it has been designed as it has.", "comment": "This element does not describe the usage of the graph 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 graph definition.", "min": 0, "max": "1", "type": [ { "code": "markdown" } ], "mapping": [ { "identity": "workflow", "map": "Definition.purpose" }, { "identity": "objimpl", "map": "no-gen-base" }, { "identity": "w5", "map": "why" } ] }, { "id": "GraphDefinition.start", "path": "GraphDefinition.start", "short": "Type of resource at which the graph starts", "definition": "The type of FHIR resource at which instances of this graph start.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } }, { "id": "GraphDefinition.profile", "path": "GraphDefinition.profile", "short": "Profile on base resource", "definition": "The profile that describes the use of the base resource.", "comment": "The code does not include the '$' prefix that is always included in the URL when the operation is invoked.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] }, { "id": "GraphDefinition.link", "path": "GraphDefinition.link", "short": "Links this graph makes rules about", "definition": "Links this graph makes rules about.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "GraphDefinition.link.path", "path": "GraphDefinition.link.path", "short": "Path in the resource that contains the link", "definition": "Path in the resource that contains the link.", "comment": "The path can be a literal path (e.g. Observation.subject), or it can be a query for reverse links (e.g. Provenance?target=[id]).", "min": 1, "max": "1", "type": [ { "code": "string" } ] }, { "id": "GraphDefinition.link.sliceName", "path": "GraphDefinition.link.sliceName", "short": "Which slice (if profiled)", "definition": "Which slice (if profiled).", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "GraphDefinition.link.min", "path": "GraphDefinition.link.min", "short": "Minimum occurrences for this link", "definition": "Minimum occurrences for this link.", "min": 0, "max": "1", "type": [ { "code": "integer" } ] }, { "id": "GraphDefinition.link.max", "path": "GraphDefinition.link.max", "short": "Maximum occurrences for this link", "definition": "Maximum occurrences for this link.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "GraphDefinition.link.description", "path": "GraphDefinition.link.description", "short": "Why this link is specified", "definition": "Information about why this link is of interest in this graph definition.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "GraphDefinition.link.target", "path": "GraphDefinition.link.target", "short": "Potential target for the link", "definition": "Potential target for the link.", "min": 1, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "GraphDefinition.link.target.type", "path": "GraphDefinition.link.target.type", "short": "Type of resource this link refers to", "definition": "Type of resource this link refers to.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ResourceType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } } }, { "id": "GraphDefinition.link.target.profile", "path": "GraphDefinition.link.target.profile", "short": "Profile for the target resource", "definition": "Profile for the target resource.", "min": 0, "max": "1", "type": [ { "code": "uri" } ] }, { "id": "GraphDefinition.link.target.compartment", "path": "GraphDefinition.link.target.compartment", "short": "Compartment Consistency Rules", "definition": "Compartment Consistency Rules.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ] }, { "id": "GraphDefinition.link.target.compartment.code", "path": "GraphDefinition.link.target.compartment.code", "short": "Identifies the compartment", "definition": "Identifies the compartment.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "CompartmentCode" } ], "strength": "required", "description": "Identifies a compartment", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/compartment-type" } } }, { "id": "GraphDefinition.link.target.compartment.rule", "path": "GraphDefinition.link.target.compartment.rule", "short": "identical | matching | different | custom", "definition": "identical | matching | different | no-rule | custom.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GraphCompartmentRule" } ], "strength": "required", "description": "How a compartment must be linked", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/graph-compartment-rule" } } }, { "id": "GraphDefinition.link.target.compartment.expression", "path": "GraphDefinition.link.target.compartment.expression", "short": "Custom rule, as a FHIRPath expression", "definition": "Custom rule, as a FHIRPath expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "GraphDefinition.link.target.compartment.description", "path": "GraphDefinition.link.target.compartment.description", "short": "Documentation for FHIRPath expression", "definition": "Documentation for FHIRPath expression.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "GraphDefinition.link.target.link", "path": "GraphDefinition.link.target.link", "short": "Additional links from target resource", "definition": "Additional links from target resource.", "min": 0, "max": "*", "contentReference": "#GraphDefinition.link" } ] } }