io.github.linuxforhealth.api.FHIRResourceTemplate Maven / Gradle / Ivy

/*
 * (C) Copyright IBM Corp. 2020
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package io.github.linuxforhealth.api;

/**
 * Represents a template to generate a FHIR resource. 

 * Each template defines the following attributes:
 * 
 * Name
 * {@link ResourceModel}
 * If the resource is a list - multiple values needs to be generated
 * If the resource is referenced
 * 
 * 
 *
 * @author pbhallam
 */
public interface FHIRResourceTemplate {


  /**
   * Resource Name
   * 
   * @return String
   */
  String getResourceName();

  /**
   * ResourceModel
   * 
   * @return {@link ResourceModel}
   */
  ResourceModel getResource();

  /**
   * If multiple resources of this type needs to be generated
   * 
   * @return True/False
   */
  boolean isGenerateMultiple();

  /**
   * If this resource is referenced by other resources
   * 
   * @return True/False
   */
  boolean isReferenced();



}