ServiceDefinition - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
approvalDatefalsedate When the service definition was approved by publisher
contacttrueContactDetail Contact details for the publisher
contributortrueContributor A content contributor
copyrightfalsemarkdown Use and/or publishing restrictions
dataRequirementtrueDataRequirement What data is used by the module
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the service definition
effectivePeriodfalsePeriod When the service definition is expected to be used
experimentalfalseboolean For testing purposes, not real usage
identifiertrueIdentifier Additional identifier for the service definition
jurisdictiontrueCodeableConcept Intended jurisdiction for service definition (if applicable)
lastReviewDatefalsedate When the service definition was last reviewed
namefalsestring Name for this service definition (computer friendly)
operationDefinitionfalseReference Operation to invoke
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this service definition is defined
relatedArtifacttrueRelatedArtifact Additional documentation, citations, etc
statusfalsecode draft | active | retired | unknown
titlefalsestring Name for this service definition (human friendly)
topictrueCodeableConcept E.g. Education, Treatment, Assessment, etc
triggertrueTriggerDefinition "when" the module should be invoked
urlfalseuri Logical URI to reference this service definition (globally unique)
usagefalsestring Describes the clinical usage of the module
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the service definition

ServiceDefinition Example

{
  "status": "draft",
  "description": "Guideline appropriate ordering is used to assess appropriateness of an order given a patient, a proposed order, and a set of clinical indications.",
  "title": "Guideline Appropriate Ordering Module",
  "resourceType": "ServiceDefinition",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Id: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">ServiceDefinition/example</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Identifier: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">\n                  <b>value: </b>\n                  <span>guildeline-appropriate-ordering</span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Title: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">Guideline Appropriate Ordering Module</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Status: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">draft</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Description: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">Guideline appropriate ordering is used to assess appropriateness of an order given a patient, a proposed order, and a set of clinical indications.</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Topic: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-right: 25px;\">\n                  <span style=\"padding-left: 25px;\">\n                     <b>text: </b>\n                     <span>Guideline Appropriate Ordering</span>\n                     <br/>\n                  </span>\n               </td>\n            </tr>\n         </table>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Topic: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-right: 25px;\">\n                  <span style=\"padding-left: 25px;\">\n                     <b>text: </b>\n                     <span>Appropriate Use Criteria</span>\n                     <br/>\n                  </span>\n               </td>\n            </tr>\n         </table>\n      </div>"
  },
  "topic": [
    {
      "text": "Guideline Appropriate Ordering"
    },
    {
      "text": "Appropriate Use Criteria"
    }
  ],
  "version": "1.0.0",
  "date": "2015-07-22",
  "identifier": [
    {
      "use": "official",
      "value": "guildeline-appropriate-ordering"
    }
  ],
  "id": "example"
}

ServiceDefinition Structure


  
{
  "resourceType" : "ServiceDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this service definition (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the service definition
  "version" : "<string>", // Business version of the service definition
  "name" : "<string>", // Name for this service definition (computer friendly)
  "title" : "<string>", // Name for this service definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "description" : "<markdown>", // Natural language description of the service definition
  "purpose" : "<markdown>", // Why this service definition is defined
  "usage" : "<string>", // Describes the clinical usage of the module
  "approvalDate" : "<date>", // When the service definition was approved by publisher
  "lastReviewDate" : "<date>", // When the service definition was last reviewed
  "effectivePeriod" : { Period }, // When the service definition is expected to be used
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for service definition (if applicable)
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "contributor" : [{ Contributor }], // A content contributor
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "trigger" : [{ TriggerDefinition }], // "when" the module should be invoked
  "dataRequirement" : [{ DataRequirement }], // What data is used by the module
  "operationDefinition" : { Reference(OperationDefinition) } // Operation to invoke
}


 

ServiceDefinition Search Parameters

The following search parameters can be used to query ServiceDefinition resources. Just submit the like so:

https://api.1up.health/fhir/stu3/ServiceDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
composed-ofreferencerelatedArtifact.where
datedatedate
depends-onreferencerelatedArtifact.where
derived-fromreferencerelatedArtifact.where
descriptiontextdescription
effectivedateeffectivePeriod
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
predecessorreferencerelatedArtifact.where
publishertextpublisher
statustextstatus
successorreferencerelatedArtifact.where
titletexttitle
topictexttopic
urluriurl
versiontextversion