Example EnrollmentRequest/22345 (JSON)

• Does this service have specific eligibility requirements that need to be met in order to use the service eligibility : CodeableConcept Narrative 0..1
• The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page eligibilityNote : string XML 0..1
• Program Names that can be used to categorize the service programName : string JSON 0..*
• Collection of Characteristics (attributes) characteristic : CodeableConcept TTL 0..*
Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required referralMethod : CodeableConcept

Raw JSON 0..* « ( The methods of referral can be used when referring to a specific HealthCareService resource ReferralMethod ) » The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available publicKey : string 0..1 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 ServiceType The specific type of service being delivered or performed type : CodeableConcept 1..1 « Additional details about where the content was created (e.g. clinical specialty) DocumentC80PracticeSetting canonical form + » Collection of Specialties handled by the Service Site. This is more of a Medical Term specialty : CodeableConcept 0..* AvailableTime Indicates which Days of the week are available between the Start and End Times daysOfWeek : CodeableConcept 0..* 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 A specific type of service that may be delivered or performed serviceType 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 also see JSON Format Specification 0..* XML Template )

{
  "resourceType": "EnrollmentRequest",
  "id": "22345",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">A human-readable rendering of the EnrollmentRequest.</div>"
  },
  "identifier": [
    {
      "system": "http://happyvalley.com/enrollmentrequest",
      "value": "EN22345"
    }
  ],
  "status": "active",
  "created": "2014-08-16",
  "insurer": {
    "reference": "Organization/2"
  },
  "provider": {
    "reference": "Organization/1"
  },
  "candidate": {
    "reference": "Patient/1"
  },
  "coverage": {
    "reference": "Coverage/9876B1"
  }

}

Structure Name Flags Card. Type Description & Constraints HealthcareService DomainResource The details of a Healthcare Service available at a location identifier Σ 0..* Identifier External Identifiers for this item providedBy Σ 0..1 Organization The organization that provides this Healthcare Service location Σ 1..1 Location The location where this healthcare service may be provided serviceCategory Σ 0..1 CodeableConcept Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type serviceType Σ 0..* Element A specific type of service that may be delivered or performed type Σ 1..1 CodeableConcept The specific type of service being delivered or performed DocumentC80PracticeSetting ( Preferred ) specialty Σ 0..* CodeableConcept Collection of Specialties handled by the Service Site. This is more of a Medical Term serviceName Σ 0..1 string Further description of the service as it would be presented to a consumer while searching comment Σ 0..1 string Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName extraDetails 0..1 string Extra details about the service that can't be placed in the other fields photo Σ 0..1 Attachment 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 telecom 0..* ContactPoint List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts coverageArea 0..* Location The location(s) that this service is available to (not where the service is provided) eligibility 0..1 CodeableConcept Does this service have specific eligibility requirements that need to be met in order to use the service eligibilityNote 0..1 string Describes the eligibility conditions for the service programName 0..* string Program Names that can be used to categorize the service characteristic 0..* CodeableConcept Collection of Characteristics (attributes) referralMethod 0..* CodeableConcept Ways that the service accepts referrals ReferralMethod ( Example ) publicKey 0..1 string The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available appointmentRequired 0..1 boolean Indicates if an appointment is required for access Usage note: every effort has been made to this service availableTime 0..* Element A Collection of times ensure that the Service Site is available daysOfWeek 0..* CodeableConcept mon | tue | wed | thu | fri | sat | sun allDay 0..1 boolean Is this always available? (hence times examples are irrelevant) e.g. 24 hour service availableStartTime 0..1 time The opening time of day. Note: If the AllDay flag is set, then this time is ignored availableEndTime 0..1 time The closing time of day. Note: If the AllDay flag is set, then this time is ignored notAvailable 0..* Element The HealthcareService is not available during this period of time due to the provided reason description 1..1 string The reason that can be presented to the user as to why this time is not available during 0..1 Period Service is not available (seasonally or for a public holiday) from this date availabilityExceptions 0..1 string 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 correct and Not Available Times UML Diagram HealthcareService ( DomainResource ) External Identifiers for this item identifier : Identifier 0..* The organization that provides this Healthcare Service providedBy : Reference ( Organization ) 0..1 The location where this healthcare service may be provided location : Reference ( Location ) 1..1 Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type serviceCategory : CodeableConcept 0..1 Further description of the service as it would be presented to a consumer while searching serviceName : string 0..1 Additional description of the 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 : string 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. If this is empty, then refer to the location's contacts telecom : ContactPoint 0..* The location(s) that this service is available to (not where the service is provided) coverageArea : Reference ( Location ) 0..* Does this service have specific eligibility requirements that need to be met in order to use the service eligibility : CodeableConcept 0..1 The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if useful, but they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page eligibilityNote : string 0..1 Program Names that can be used to categorize the service programName : string 0..* Collection of Characteristics (attributes) characteristic : CodeableConcept 0..* 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 ReferralMethod ) » The public normative part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available publicKey : string 0..1 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 ServiceType The specific type of service being delivered or performed type : CodeableConcept 1..1 « Additional details about where the content was created (e.g. clinical specialty) DocumentC80PracticeSetting + » Collection of Specialties handled by the Service Site. This is more of a Medical Term specialty : CodeableConcept 0..* AvailableTime Indicates which Days of the week are available between the Start and End Times daysOfWeek : CodeableConcept 0..* 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 A specific type of service that may be delivered or performed serviceType 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> < The organization that provides this Healthcare Service</providedBy> < The location where this healthcare service may be provided</location> < Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type</serviceCategory> < <</type> < Collection of Specialties handled by the Service Site. This is more of a Medical Term</specialty> </serviceType> < Further description of the service as it would be presented to a consumer while searching < Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName < < 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> < List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts</telecom> < The location(s) that this service is available to (not where the service is provided)</coverageArea> < Does this service have specific eligibility requirements that need to be met in order to use the service</eligibility> < < < Collection of Characteristics (attributes)</characteristic> <</referralMethod> < The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available < < <</daysOfWeek> < < The opening time of day. Note: If the AllDay flag is set, then this time is ignored < The closing time of day. Note: If the AllDay flag is set, then this time is ignored </availableTime> < < < Service is not available (seasonally or for a public holiday) from this date</during> </notAvailable> < 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 </HealthcareService> JSON Template specification.