IG Test3 Implementation Guide CI Build

IG Test3 - Local Development build (v0.0.0). See the Directory of published versions

StructureDefinition-template-profile-on-profile

source file: source/pages/_includes/template-profile-on-profile-intro.md

Scope and Usage

scope and usage text here

Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). blah blah blah

must have:

  1. blah
  2. blah
  3. blah

Additional Profile specific implementation guidance:

Examples

  • Patient/example /Users/ehaas/Documents/FHIR/IG-Template2/source/examples/patient-example
  • Patient/example2 /Users/ehaas/Documents/FHIR/IG-Template2/source/examples/patient-example2
  • Formal Views of Profile Content

    Description of Profiles, Differentials, and Snapshots.

    The official URL for this profile is: http://www.fhir.org/guides/test3/StructureDefinition/template-profile-on-profile

    Published on Wed Feb 15 00:00:00 PST 2017 as active by the Health eData Inc.

    This profile builds on US Core Patient Profile


    Summary

    Mandatory: 2 elements
    Must-Support: 2 elements
    Fixed Value: 1 element

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient 0..*Template-Profile-on-Profile
    ... identifier S1..1Identifier
    .... system S1..1uriFixed Value: http://Healthedata1/IG-Template/patient-ids

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient I0..*Template-Profile-on-Profile
    ... id Σ0..1idLogical id of this artifact
    ... meta Σ0..1MetaMetadata about the resource
    ... implicitRules ?!Σ0..1uriA set of rules under which this content was created
    ... language 0..1codeLanguage of the resource content
    Binding: CommonLanguages (preferred)
    Max Binding: AllLanguages
    ... text 0..1NarrativeText summary of the resource, for human interpretation
    ... contained 0..*ResourceContained, inline Resources
    ... extension 0..*ExtensionExtension
    Slice: Unordered, Open by value:url
    ... us-core-race S0..1(Complex)Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... us-core-ethnicity S0..1(Complex)Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... us-core-birthsex S0..1codeExtension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
    Binding: Birth Sex (required)
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... identifier SΣ1..1IdentifierAn identifier for this patient
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required)
    .... type Σ0..1CodeableConceptDescription of identifier
    Binding: Identifier Type Codes (extensible)
    .... system SΣ1..1uriThe namespace for the identifier value
    Fixed Value: http://Healthedata1/IG-Template/patient-ids
    .... value SΣ1..1stringThe value that is unique within the system.
    Example General: 123456
    .... period Σ0..1PeriodTime period when id is/was valid for use
    .... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
    ... active ?!Σ0..1booleanWhether this patient's record is in active use
    ... name SΣ1..*HumanNameA name associated with the patient
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required)
    .... text Σ0..1stringText representation of the full name
    .... family SΣ1..1stringFamily name (often called 'Surname')
    .... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    .... prefix Σ0..*stringParts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ0..*stringParts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ0..1PeriodTime period when name was/is in use
    ... telecom Σ0..*ContactPointA contact detail for the individual
    ... gender SΣ1..1codemale | female | other | unknown
    Binding: AdministrativeGender (required)
    ... birthDate SΣ0..1dateThe date of birth for the individual
    ... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
    .... deceasedBooleanboolean
    .... deceasedDateTimedateTime
    ... address Σ0..*AddressAn address for the individual
    ... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
    Binding: Marital Status Codes (extensible)
    ... multipleBirth[x] 0..1Whether patient is part of a multiple birth
    .... multipleBirthBooleanboolean
    .... multipleBirthIntegerinteger
    ... photo 0..*AttachmentImage of the patient
    ... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
    pat-1: SHALL at least contain a contact's details or a reference to an organization
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... relationship 0..*CodeableConceptThe kind of relationship
    Binding: PatientContactRelationship (extensible)
    .... name 0..1HumanNameA name associated with the contact person
    .... telecom 0..*ContactPointA contact detail for the person
    .... address 0..1AddressAddress for the contact person
    .... gender 0..1codemale | female | other | unknown
    Binding: AdministrativeGender (required)
    .... organization I0..1Reference(Organization)Organization that is associated with the contact
    .... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
    ... communication SI0..*BackboneElementA language which may be used to communicate with the patient about his or her health
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
    Binding: Language codes with language and optionally a region modifier (extensible)
    Max Binding: Language codes with language and optionally a region modifier
    .... preferred 0..1booleanLanguage preference indicator
    ... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
    ... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
    ... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
    .... type Σ1..1codereplaced-by | replaces | refer | seealso
    Binding: LinkType (required)

    doco Documentation for this format
    
           // Template Profile on Profile
     {
       "resourceType" : "Patient",
        "id" : "<id>", // Logical id of this artifact
        "meta" : {Meta}, // Metadata about the resource
        "implicitRules" : "<uri>", // A set of rules under which this content was created
        "language" : "<code>", // Language of the resource content
        "text" : {Narrative}, // Text summary of the resource, for human interpretation
        "contained" : [{Resource}], // Contained, inline Resources
        "extension": [
          { //  Only One! Extension
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
    Not handled yet: complex extension http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
          },
          { //  Only One! Extension
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
    Not handled yet: complex extension http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
          },
          { //  Only One! Extension
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
            "valueCode" : "<code>" // Value of extension
          }
        ],
        "identifier" : [{ // R! Only One!  An identifier for this patient
          "extension": [
          ],
          "use" : "<code>", // usual | official | temp | secondary | old (If known)
          "type" : {CodeableConcept}, // Description of identifier
          "system" : "http://Healthedata1/IG-Template/patient-ids", // R!
          "value" : "<string>", // R! The value that is unique within the system.
          "period" : {Period}, // Time period when id is/was valid for use
          "assigner" : {Reference(Organization)} // Organization that issued id (may be just text)
        }],
        "active" : <boolean>, // Whether this patient's record is in active use
        "name" : [{ // R! A name associated with the patient
          "extension": [
          ],
          "use" : "<code>", // usual | official | temp | nickname | anonymous | old | maiden
          "text" : "<string>", // Text representation of the full name
          "family" : "<string>", // R! Family name (often called 'Surname')
          "given" : ["<string>"], // R! Given names (not always 'first'). Includes middle names
          "prefix" : ["<string>"], // Parts that come before the name
          "suffix" : ["<string>"], // Parts that come after the name
          "period" : {Period} // Time period when name was/is in use
        }],
        "telecom" : [{ContactPoint}], // A contact detail for the individual
        "gender" : "<code>", // R! male | female | other | unknown
        "birthDate" : "<date>", // The date of birth for the individual
    // deceased[x]: Indicates if the individual is deceased or not. One of these 2:
        "deceasedBoolean" : <boolean>, // Indicates if the individual is deceased or not
        "deceasedDateTime" : "<dateTime>", // Indicates if the individual is deceased or not
        "address" : [{Address}], // An address for the individual
        "maritalStatus" : {CodeableConcept}, // Marital (civil) status of a patient
    // multipleBirth[x]: Whether patient is part of a multiple birth. One of these 2:
        "multipleBirthBoolean" : <boolean>, // Whether patient is part of a multiple birth
        "multipleBirthInteger" : <integer>, // Whether patient is part of a multiple birth
        "photo" : [{Attachment}], // Image of the patient
        "contact" : [{ // C? A contact party (e.g. guardian, partner, friend) for the patient
          "extension": [
          ],
          "relationship" : [{CodeableConcept}], // The kind of relationship
          "name" : {HumanName}, // A name associated with the contact person
          "telecom" : [{ContactPoint}], // A contact detail for the person
          "address" : {Address}, // Address for the contact person
          "gender" : "<code>", // male | female | other | unknown
          "organization" : {Reference(Organization)}, // Organization that is associated with the contact
          "period" : {Period}, // The period during which this contact person or organization is valid to be contacted relating to this patient
        }],
        "communication" : [{ // C? A language which may be used to communicate with the patient about his or her health
          "extension": [
          ],
          "language" : {CodeableConcept}, // R! The language which can be used to communicate with the patient about his or her health
          "preferred" : <boolean>, // Language preference indicator
        }],
        "generalPractitioner" : [{Reference(Organization)}], // Patient's nominated primary care provider
        "managingOrganization" : {Reference(Organization)}, // Organization that is the custodian of the patient record
        "link" : [{ // C? Link to another patient resource that concerns the same actual person
          "extension": [
          ],
          "other" : {Reference(Patient)}, // R! The other patient or related person resource that the link refers to
          "type" : "<code>", // R! replaced-by | replaces | refer | seealso
        }],
      }
    
         

    Summary

    Mandatory: 2 elements
    Must-Support: 2 elements
    Fixed Value: 1 element

    Differential View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient 0..*Template-Profile-on-Profile
    ... identifier S1..1Identifier
    .... system S1..1uriFixed Value: http://Healthedata1/IG-Template/patient-ids

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient I0..*Template-Profile-on-Profile
    ... id Σ0..1idLogical id of this artifact
    ... meta Σ0..1MetaMetadata about the resource
    ... implicitRules ?!Σ0..1uriA set of rules under which this content was created
    ... language 0..1codeLanguage of the resource content
    Binding: CommonLanguages (preferred)
    Max Binding: AllLanguages
    ... text 0..1NarrativeText summary of the resource, for human interpretation
    ... contained 0..*ResourceContained, inline Resources
    ... extension 0..*ExtensionExtension
    Slice: Unordered, Open by value:url
    ... us-core-race S0..1(Complex)Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... us-core-ethnicity S0..1(Complex)Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... us-core-birthsex S0..1codeExtension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
    Binding: Birth Sex (required)
    ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
    ... identifier SΣ1..1IdentifierAn identifier for this patient
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required)
    .... type Σ0..1CodeableConceptDescription of identifier
    Binding: Identifier Type Codes (extensible)
    .... system SΣ1..1uriThe namespace for the identifier value
    Fixed Value: http://Healthedata1/IG-Template/patient-ids
    .... value SΣ1..1stringThe value that is unique within the system.
    Example General: 123456
    .... period Σ0..1PeriodTime period when id is/was valid for use
    .... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
    ... active ?!Σ0..1booleanWhether this patient's record is in active use
    ... name SΣ1..*HumanNameA name associated with the patient
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required)
    .... text Σ0..1stringText representation of the full name
    .... family SΣ1..1stringFamily name (often called 'Surname')
    .... given SΣ1..*stringGiven names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    .... prefix Σ0..*stringParts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ0..*stringParts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ0..1PeriodTime period when name was/is in use
    ... telecom Σ0..*ContactPointA contact detail for the individual
    ... gender SΣ1..1codemale | female | other | unknown
    Binding: AdministrativeGender (required)
    ... birthDate SΣ0..1dateThe date of birth for the individual
    ... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
    .... deceasedBooleanboolean
    .... deceasedDateTimedateTime
    ... address Σ0..*AddressAn address for the individual
    ... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
    Binding: Marital Status Codes (extensible)
    ... multipleBirth[x] 0..1Whether patient is part of a multiple birth
    .... multipleBirthBooleanboolean
    .... multipleBirthIntegerinteger
    ... photo 0..*AttachmentImage of the patient
    ... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
    pat-1: SHALL at least contain a contact's details or a reference to an organization
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... relationship 0..*CodeableConceptThe kind of relationship
    Binding: PatientContactRelationship (extensible)
    .... name 0..1HumanNameA name associated with the contact person
    .... telecom 0..*ContactPointA contact detail for the person
    .... address 0..1AddressAddress for the contact person
    .... gender 0..1codemale | female | other | unknown
    Binding: AdministrativeGender (required)
    .... organization I0..1Reference(Organization)Organization that is associated with the contact
    .... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
    ... communication SI0..*BackboneElementA language which may be used to communicate with the patient about his or her health
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
    Binding: Language codes with language and optionally a region modifier (extensible)
    Max Binding: Language codes with language and optionally a region modifier
    .... preferred 0..1booleanLanguage preference indicator
    ... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
    ... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
    ... link ?!ΣI0..*BackboneElementLink to another patient resource that concerns the same actual person
    .... id 0..1stringUnique id for inter-element referencing
    .... extension 0..*ExtensionAdditional content defined by implementations
    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
    .... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
    .... type Σ1..1codereplaced-by | replaces | refer | seealso
    Binding: LinkType (required)

    doco Documentation for this format

    Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


    Quick Start

    Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

    source file: source/pages/_includes/template-profile-on-profile-search.md

    This is the search markdown file that gets inserted into the sd.html Quick Start section for explanation of the search requirements.