Example ValueSet/message-events (JSON)

• Structure Narrative
UML
• XML
• JSON
Turtle
• R3 Diff TTL
All

Structure Name Flags Card. Type Description & Constraints HealthcareService TU DomainResource The details of a healthcare service available at a location Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension identifier Σ 0..* Identifier External identifiers for this item active ?! Σ 0..1 boolean Whether this HealthcareService record is in active use providedBy Σ 0..1 Reference ( Organization ) Organization that provides this service category Σ 0..* CodeableConcept Broad category of service being performed or delivered Service category ( Example ) type Σ 0..* CodeableConcept Type of service that may be delivered or performed Service type ( Example ) specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService Practice Setting Code Value Set ( Preferred ) location Σ 0..* Reference ( Location ) Location(s) where service may be provided name Σ 0..1 string Description of service as presented to a consumer while searching comment Σ 0..1 string Additional description and/or any specific issues not covered elsewhere extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields photo Σ 0..1 Attachment Facilitates quick identification of the service telecom 0..* ContactPoint Contacts related to the healthcare service coverageArea 0..* Reference ( Location ) Location(s) service is intended for/available to serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered ServiceProvisionConditions ( Example ) eligibility 0..* BackboneElement Specific eligibility requirements required to use the service code 0..1 CodeableConcept Coded value for the eligibility comment 0..1 markdown Describes the eligibility conditions for the service program 0..* CodeableConcept Programs that this service is applicable to Program ( Example ) characteristic 0..* CodeableConcept Collection of characteristics (attributes) communication 0..* CodeableConcept The language that this service is offered in Common Languages ( Preferred but limited to AllLanguages ) referralMethod 0..* CodeableConcept Ways that the service accepts referrals ReferralMethod ( Example ) appointmentRequired 0..1 boolean If an appointment is required for access to this service availableTime 0..* BackboneElement Times the Service Site is available daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun DaysOfWeek ( Required ) allDay 0..1 boolean Always available? e.g. 24 hour service availableStartTime 0..1 time Opening time of day (ignored if allDay = true) availableEndTime 0..1 time Closing time of day (ignored if allDay = true) notAvailable 0..* BackboneElement Not available during this time due to provided reason description 1..1 string Reason presented to the user explaining why time not available during 0..1 Period Service not available from this date availabilityExceptions 0..1 string Description of availability exceptions endpoint 0..* Reference ( Endpoint ) Technical endpoints providing access to electronic services operated for the healthcare service Documentation for this format UML Diagram ( Legend ) HealthcareService ( DomainResource ) External identifiers for this item identifier : Identifier [0..*] This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this (this element modifies the meaning of other elements) active : boolean [0..1] The organization that provides this healthcare service providedBy : Reference [0..1] « Organization » Identifies the broad category of service being performed or delivered category : CodeableConcept [0..*] « A category of the service(s) that could be provided. (Strength=Example) ServiceCategory ?? » The specific type of service that may be delivered or performed type : CodeableConcept [0..*] « Additional details about where the content was created (e.g. clinical specialty). (Strength=Example) ServiceType ?? » Collection of specialties handled by the service site. This is more of a medical term specialty : CodeableConcept [0..*] « A specialty that a healthcare service may provide. (Strength=Preferred) PracticeSettingCodeValueSet ? » The location(s) where this healthcare service may be provided location : Reference [0..*] « Location » Further description of the service as it would be presented to a consumer while searching name : string [0..1] Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName comment : string [0..1] Extra details about the service that can't be placed in the other fields extraDetails : markdown [0..1] If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list photo : Attachment [0..1] List of contacts related to this specific healthcare service telecom : ContactPoint [0..*] The location(s) that this service is available to (not where the service is provided) coverageArea : Reference [0..*] « Location » The code(s) that detail the conditions under which the healthcare service is available/offered serviceProvisionCode : CodeableConcept [0..*] « The code(s) that detail the conditions under which the healthcare service is available/offered. (Strength=Example) ServiceProvisionConditions ?? » Programs that this service is applicable to program : CodeableConcept [0..*] « Government or local programs that this service applies to. (Strength=Example) Program ?? » Collection of characteristics (attributes) characteristic : CodeableConcept [0..*] Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used communication : CodeableConcept [0..*] « A human language. (Strength=Preferred) CommonLanguages ? » Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept [0..*] « The methods of referral can be used when referring to a specific HealthCareService resource. (Strength=Example) ReferralMethod ?? » Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service appointmentRequired : boolean [0..1] A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times availabilityExceptions : string [0..1] Technical endpoints providing access to services operated for the specific healthcare services defined at this resource endpoint : Reference [0..*] « Endpoint » Eligibility Coded value for the eligibility code : CodeableConcept [0..1] Describes the eligibility conditions for the service comment : markdown [0..1] AvailableTime Indicates which days of the week are available between the start and end Times daysOfWeek : code [0..*] « The days of the week. (Strength=Required) DaysOfWeek ! » Is this always available? (hence times are irrelevant) e.g. 24 hour service allDay : boolean [0..1] The opening time of day. Note: If the AllDay flag is set, then this time is ignored availableStartTime : time [0..1] The closing time of day. Note: If the AllDay flag is set, then this time is ignored availableEndTime : time [0..1] NotAvailable The reason that can be presented to the user as to why this time is not available description : string [1..1] Service is not available (seasonally or for a public holiday) from this date during : Period [0..1] Does this service have specific eligibility requirements that need to be met in order to use the service? eligibility [0..*] A collection of times that the Service Site is available availableTime [0..*] The HealthcareService is not available during this period of time due to the provided reason notAvailable [0..*] XML Template < <!-- from --> <!-- from --> <</identifier> < <</providedBy> <</category> <</type> <</specialty> <</location> < < < <</photo> <</telecom> <</coverageArea> <</serviceProvisionCode> < <</code> < </eligibility> <</program> <</characteristic> <</communication> <</referralMethod> < < < < < < </availableTime> < < <</during> </notAvailable> < <</endpoint> </HealthcareService> Raw JSON Template { "resourceType" : "", // from // from " " " " " " " " " " " " " " " " " }], " " " " " " " " " " }], " " " }], " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: ], ...; fhir: fhir: ] Changes since R3 HealthcareService HealthcareService.active Default Value "true" removed HealthcareService.category Max Cardinality changed from 1 to * HealthcareService.extraDetails Type changed from string to markdown HealthcareService.eligibility Max Cardinality changed from 1 to * Type changed from CodeableConcept to BackboneElement HealthcareService.eligibility.code Added Element HealthcareService.eligibility.comment Added Element HealthcareService.program Added Element HealthcareService.communication Added Element HealthcareService.availableTime.daysOfWeek Change value set from http://hl7.org/fhir/ValueSet/days-of-week to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 HealthcareService.eligibilityNote deleted HealthcareService.programName deleted See the Full Difference for further information This analysis is available as XML ( canonical form or + also see JSON . See R3 <--> R4 Conversion Maps Format Specification (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )

{
  "resourceType" : "ValueSet",
  "id" : "message-events",
  "meta" : {
    "lastUpdated" : "2023-03-01T23:03:57.298+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include all codes defined in <a href=\"codesystem-message-events.html\"><code>http://hl7.org/fhir/message-events</code></a></li></ul></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-special-status",
    "valueString" : "This Value Set is normative - it is generated based on the information defined in this specification. The definition will remain fixed  across versions, but the actual contents will change from version to version"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "draft"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 1

  }],
  "
  "
  "
  "
  "
  "
    "
    "
    "
    "

  "url" : "http://hl7.org/fhir/ValueSet/message-events",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.26"

  }],
  "
    "
    "

  "version" : "5.0.0-draft-final",
  "name" : "MessageEvent",
  "title" : "MessageEvent",
  "status" : "active",
  "experimental" : true,
  "date" : "2023-03-01T23:03:57+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]

  }],
  "
  "

  "description" : "One of the message events defined as part of this version of FHIR.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "immutable" : true,
  "compose" : {
    "include" : [{
      "system" : "http://hl7.org/fhir/message-events"
    }]
  }

}

Changes since Release 3 HealthcareService HealthcareService.active Default Value "true" removed HealthcareService.category Max Cardinality changed from 1 to * HealthcareService.extraDetails Type changed from string to markdown HealthcareService.eligibility Max Cardinality changed from 1 to * Type changed from CodeableConcept to BackboneElement HealthcareService.eligibility.code Added Element HealthcareService.eligibility.comment Added Element HealthcareService.program Added Element HealthcareService.communication Added Element HealthcareService.availableTime.daysOfWeek Change value set from http://hl7.org/fhir/ValueSet/days-of-week Usage note: every effort has been made to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 HealthcareService.eligibilityNote deleted HealthcareService.programName deleted See the Full Difference for further information This analysis is available as XML or JSON . See R3 <--> R4 Conversion Maps (status = 1 test ensure that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors). )   See the Profiles & Extensions examples are correct and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis 8.8.3.1 Terminology Bindings Path Definition Type Reference HealthcareService.category A category of the service(s) that could be provided. Example ServiceCategory HealthcareService.type Additional details about where the content was created (e.g. clinical specialty). Example ServiceType HealthcareService.specialty A specialty that a healthcare service may provide. Preferred PracticeSettingCodeValueSet HealthcareService.serviceProvisionCode The code(s) that detail the conditions under which the healthcare service is available/offered. Example ServiceProvisionConditions HealthcareService.eligibility.code Coded values underwhich a specific service is made available. Unknown No details provided yet HealthcareService.program Government or local programs that this service applies to. Example Program HealthcareService.characteristic A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). Unknown No details provided yet HealthcareService.communication A human language. Preferred , useful, but limited to AllLanguages CommonLanguages HealthcareService.referralMethod The methods of referral can be used when referring to they are not a specific HealthCareService resource. Example ReferralMethod HealthcareService.availableTime.daysOfWeek The days normative part of the week. Required DaysOfWeek specification.